接口功能介绍
查询云硬盘备份存储库列表
接口约束
无
URI
GET /v4/ebs-backup/repo/list-repos
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| repositoryName | 否 | String | 云硬盘备份存储库名称 | test-repo | |
| repositoryID | 否 | String | 云硬盘备份存储库ID | 9915c3f4-8d78-445a-a1da-d8d9287d506b | |
| status | 否 | String | 云硬盘备份存储库状态，active-可用，creating-创建中，error-失败，freezing-冻结，expired-已过期 | active | |
| hideExpire | 否 | Boolean | 是否隐藏过期的云硬盘备份存储库 | true | |
| queryContent | 否 | String | 目前，仅支持 备份存储库名称的过滤 | repo | |
| pageNo | 否 | Integer | 页码，默认1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目 ,默认10 | 10 | |
| asc | 否 | Boolean | 和sort配合使用，是否升序排列 | true | |
| sort | 否 | String | 和asc配合使用，指定用于排序的字段。可选字段：createdTime/expiredTime/size/freeSize/usedSize/repositoryName | createdTime | |
| projectID | 否 | String | 企业项目ID，默认“0” | 0 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 类型 | 描述 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| message | 是 | String | 错误信息的英文描述 | SUCCESS | |
| description | 是 | String | 错误信息的本地化描述（中文） | 成功 | |
| returnObj | 否 | Object | 成功时返回对象 | returnObj | |
| errorCode | 否 | String | 业务错误细分码，发生错误时返回 | 参考错误码 |
表 returnObj
| 参数名 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| repositoryList | 是 | Array | 云硬盘备份存储库列表 | repositoryList | |
| totalCount | 是 | Integer | 云硬盘备份存储库总数 | 11 | |
| currentCount | 是 | Integer | 当前页云硬盘备份存储库数 | 10 |
表 repositoryList
| 参数名 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| repositoryID | 是 | String | 备份存储库ID | 9915c3f4-8d78-445a-a1da-d8d9287d506b | |
| repositoryName | 是 | String | 备份存储库名称 | test-repo | |
| status | 是 | String | 云硬盘备份存储库状态，active-可用，creating-创建中，error-失败，freezing-冻结，expired-已到期 | active | |
| size | 是 | Integer | 云硬盘备份存储库总容量，单位GB | 100 | |
| freeSize | 是 | Float | 云硬盘备份存储库剩余大小，单位GB | 90.0 | |
| usedSize | 是 | Float | 云硬盘备份存储库使用大小，单位GB | 10.0 | |
| createdTime | 是 | Integer | 创建时间 | 663136607 | |
| expiredTime | 是 | Integer | 到期时间 | 663136607 | |
| expired | 是 | Boolean | 备份存储库是否到期 | false | |
| freeze | 是 | Boolean | 是否冻结 | false | |
| paas | 是 | Boolean | 是否支持PAAS | false | |
| backupList | 是 | array | 备份存储库下的可用的备份列表，元素为备份ID | ["59093d15-8a3c-53b9-b61b-484af10a3e97","59093d15-8a3c-53b9-b61b-484af10a3e98"] | |
| projectID | 是 | String | 企业项目ID | 0 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"totalCount": 7,
"currentCount": 1,
"repositoryList": [{
"status": "active",
"backupList": ["a2d6b860-9d06-433d-ab5e-ae59239495f2"],
"paas": false,
"regionID": "81f7728662dd11ec810800155d307d5b",
"usedSize": 1.52,
"repositoryID": "2e2f1de4-1ff8-4898-8bac-58fc39078b87",
"expiredTime": 1689531888,
"freeze": false,
"createdTime": 1673893469,
"repositoryName": "test-bak-repo",
"expired": false,
"freeSize": 98.48,
"size": 100,
"projectID": "0"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
错误码
| errorCode | 描述 |
|---|---|
| EbsBackup.RegionInfo.Empty | 查询资源池信息为空或资源池不存在，请确认资源池ID是否有效 |
| EbsBackup.RegionInfo.AccessFailed | 查询资源池失败，请重试。如果多次尝试失败，请提交工单 |
| EbsBackup.RegionInfo.DataDamaged | 查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单 |
| EbsBackup.RepositoryInfo.AccessFailed | 查询云硬盘备份存储库失败 |
| EbsBackup.RepositoryInfo.DataDamaged | 云硬盘备份存储库数据不符合预期 |
| EbsBackup.Parameter.InvalidPageParams | 请求参数错误：{错误原因} |
| EbsBackup.Parameter.InvalidRegionID | 请求参数错误：{错误原因} |
| EbsBackup.OrderCheck.InvalidProjectID | 企业项目不存在，请确认企业项目ID是否有效 |
