接口介绍
获取该用户所有存储库列表
接口约束
1、根据用户输入的存储库Name,查询该存储库信息。如不指定,则获取该用户所有存储库信息列表
URI
GET /v4/backup/query-storage-backup
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 参考请求示例 | |
backupStorageID | 否 | String | 存储库ID,如不指定,查询用户资源池下所有存储库列表 | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) | 参考响应示例 | |
message | 是 | String | 失败时的错误描述,一般为英文描述 | 参考响应示例 | |
description | 是 | String | 失败时的错误描述,一般为中文描述 | 参考响应示例 | |
returnObj | 是 | Object | 参考表returnObj | 参考表returnObj | |
errorCode | 是 | String | 业务细分码,为product.module.code三段式码。 | 参考状态码 |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
backupStorageCount | 是 | Integer | 存储库的数量 | 参考响应示例 | |
backupStorageList | 是 | Array of Objects | 存储库的详情列表 | 参考backupStorageList |
表 backupStorageList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
backupStorageID | 是 | String | 存储库ID | 参考响应示例 | |
backupStorageName | 是 | String | 存储库名称 | 参考响应示例 | |
backupStorageCapacity | 是 | String | 存储库容量 | 参考响应示例 | |
backupStorageFreeCapacity | 是 | String | 存储库剩余容量 | 参考响应示例 | |
backupStorageStatus | 是 | String | 存储库状态描述 | 参考状态枚举表 | |
backupStorageCreatTime | 是 | String | 存储库创建时间 | 参考响应示例 | |
backupStorageExpireTime | 是 | String | 存储库到期时间 | 参考响应示例 | |
regionName | 是 | String | 地域名称 | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
}
响应示例
{
"returnObj": {
"backupStorageCount": 1,
"backupStorageList":[
{
"backupStorageID" : "73f321ea-62ff-11ec-a8bc-005056898fe0",
"backupStorageName" : "strage-001",
"backupStorageCapacity" : "500 G",
"backupStorageFreeCapacity" : "200 G",
"backupStorageStatus" : "可用",
"backupStorageCreatTime" : "2022-11-08T10:07:28Z",
"backupStorageExpireTime" : "2022-12-08T10:07:28Z",
"regionName" : "neimeng8",
}
]
},
"statusCode": 800,
"message": "SUCCESS",
"description": "成功"
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
错误码
请参考状态码