接口功能介绍
通过云主机备份策略ID获取备份信息，主要获取绑定的云主机信息
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
1.使用限制，本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测
2.备份策略必须存在
URI
GET /v4/ecs/backup-policy/list-instances
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| policyID | 是 | String | 云主机备份策略ID，32字节 获取： 查 查询云主机备份策略列表 创 创建云主机备份策略 |
26da64d4a77f11ed923d0242ac110007 | |
| instanceName | 否 | String | 云主机名称，模糊过滤 | ecm-888 | |
| pageNo | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围：[1, 50]，注：默认值为10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 错误信息的英文描述 | SUCCESS | |
| description | String | 错误信息的本地化描述（中文） | 成功 | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目 | 5 | |
| currentPage | Integer | 当前页码 | 1 | |
| totalCount | Integer | 总记录数 | 10 | |
| totalPage | Integer | 总页数 | 1 | |
| instancePolicies | Array of Objects | 分页明细 | instancePolicies |
表 instancePolicies
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| status | String | 云主机状态 | ACTIVE | |
| attachedVolumes | Array of Strings | 云主机所关联的云硬盘ID列表 | ["8e8f8bc8-b8ad-8a8e-8e88-88cd88888e88"] | |
| displayName | String | 云主机显示名称 | ecm-6666 | |
| instanceID | String | 云主机ID | 142dcec0-31c4-1f50-708a-43a7edb94a52 | |
| regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| instanceName | String | 云主机名称 | ecm-8888 | |
| createTime | String | 创建时间 | 2023-01-29T07:28:44Z | |
| updateTime | String | 更新时间 | 2023-01-29T07:28:44Z |
枚举参数
无
请求示例
请求url
示例：查询云主机备份策略绑定的云主机的详细信息
GET `.../openapi/v4/ecs/backup-policy/list-instances?policyID=26da64d4a77f11ed923d0242ac110007®ionID=bb9fdb42056f11eda1610242ac110002`
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"totalCount": 2,
"totalPage": 1,
"instancePolicies": [
{
"status": "SHUTOFF",
"attachedVolumes": [
"7741c83b-6d34-402a-a225-3895813254cf",
"6dba6d18-b5f3-479f-b520-6f11a1d8bea6"
],
"displayName": "api-New-0003",
"instanceID": "ab12cf45ad",
"regionID": "81f7728662dd11ec810800155d307d5b",
"instanceName": "api-batchnew-0003",
"createTime": "2023-01-29T07:28:44Z",
"updateTime": "2023-01-29T07:28:44Z"
},
{
"status": "ACTIVE",
"attachedVolumes": [
"e734bfa7-3eb3-45ac-8109-187de80d48c0",
"35bcbcf3-c2fe-4c6e-be28-1f97f723ebd9"
],
"displayName": "new-test-0002",
"instanceID": "142dcec0-31c4-1f50-708a-43a7edb94a52",
"regionID": "ab12cf45ad",
"instanceName": "new-test-0002",
"createTime": "2023-01-29T07:28:44Z",
"updateTime": "2023-01-29T07:28:44Z"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
