接口功能介绍
查询云硬盘备份策略绑定的云硬盘列表
接口约束
无
URI
GET /v4/ebs-backup/policy/list-disks
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| policyID | 是 | String | 备份策略ID | d15e7d402f8f11ed81370242ac110006 | |
| pageNo | 否 | Integer | 页码，默认1 | 1 | |
| pageSize | 否 | Integer | 每页显示条目，默认10 | 10 | |
| diskID | 否 | String | 云硬盘ID | b9631b82-2087-4e54-b142-5640156ac932 | |
| diskName | 否 | String | 云硬盘名称，模糊过滤，指定diskID时，该参数无效 | ecm |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 类型 | 描述 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| message | 是 | String | 错误信息的英文描述 | SUCCESS | |
| description | 是 | String | 错误信息的本地化描述（中文） | 成功 | |
| returnObj | 否 | Object | 成功时返回对象 | returnObj | |
| errorCode | 否 | String | 业务错误细分码，发生错误时返回 | 参考错误码 |
表 returnObj
| 参数名 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| diskList | 是 | Array | 云硬盘列表 | diskList | |
| totalCount | 是 | Integer | 云硬盘总数 | 20 | |
| currentCount | 是 | Integer | 当前页云硬盘数 | 10 |
表 diskList
| 参数名 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| diskID | 是 | String | 云硬盘ID | b9631b82-2087-4e54-b142-5640156ac932 | |
| diskName | 是 | String | 云硬盘名称 | ecm-test-0001-volume-000 | |
| diskSize | 是 | Integer | 云硬盘大小，单位GB | 40 | |
| diskStatus | 是 | String | 云硬盘使用状态 available、in-use等，具体请参考云硬盘使用状态 | in-use | |
| diskType | 是 | String | 云硬盘类型 SATA/SAS/SSD-genric/SSD/FAST-SSD | SATA | |
| diskMode | 是 | String | 云硬盘模式 VBD/ISCSI/FCSAN | VBD | |
| createdTime | 是 | Integer | 创建时间 | 663136607 | |
| expiredTime | 是 | Integer | 过期时间 | 663136607 | |
| instanceID | 是 | String | 云硬盘挂载的云主机ID | bb46064b-5a94-4b77-881a-11fd1d6f8a6d | |
| instanceName | 是 | String | 云硬盘挂载的云主机名称 | ecm-test-0001 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"totalCount": 1,
"currentCount": 1,
"diskList": [{
"instanceID": "bb46064b-5a94-4b77-881a-11fd1d6f8a6d",
"diskName": "ecm-test-0001-volume-000",
"expiredTime": 1677549810,
"diskSize": 40,
"diskMode": "VBD",
"diskStatus": "in-use",
"createdTime": 1672279410,
"instanceName": "ecm-test-0001",
"diskID": "b9631b82-2087-4e54-b142-5640156ac932",
"diskType": "SATA"
}]},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
错误码
| errorCode | 描述 |
|---|---|
| EbsBackup.RegionInfo.Empty | 查询资源池信息为空或资源池不存在，请确认资源池ID是否有效 |
| EbsBackup.RegionInfo.AccessFailed | 查询资源池失败，请重试。如果多次尝试失败，请提交工单 |
| EbsBackup.RegionInfo.DataDamaged | 查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单 |
| EbsBackup.Parameter.InvalidPageParams | 请求参数错误:{错误原因} |
| EbsBackup.Parameter.InvalidPolicyID | 请求参数错误:{错误原因} |
| EbsBackup.Parameter.InvalidRegionID | 请求参数错误：{错误原因} |
