查询快照策略绑定云主机列表
接口功能介绍
查询快照策略绑定云主机列表
接口约束
无
URI
POST /v4/ecs/snapshot-policy/instance-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 81f7728662dd11ec810800155d307d5b | |
snapshotPolicyID | 是 | String | 云主机快照策略ID,32字节 | 4f69f096066011ee9caf0242ac110002 | |
pageNo | 否 | Integer | 页码,取值范围:大于等于1,默认值为1 | 1 | |
pageSize | 否 | Integer | 每页记录数目,取值范围:[1~50],默认值:10,单页最大记录不超过50 | 10 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
currentCount | Integer | 当前页记录数目 | 1 | |
totalCount | Integer | 总记录数 | 10 | |
totalPage | Integer | 总页数 | 1 | |
instanceList | Array of Objects | 分页明细 | instanceList |
表instanceList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceID | Integer | 云主机ID | 8d130fba-a3f3-c434-2855-283c96782545 | |
instanceName | String | 云主机名称 | openapi-vm149573 | |
displayName | String | 云主机展示名称 | openapi-vm149573 | |
instanceStatus | String | 云主机状态 | running | |
volumeCount | Integer | 磁盘数量 | 1 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"snapshotPolicyID": "4f69f096066011ee9caf0242ac110002"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"instanceList": [
{
"instanceID": "8d130fba-a3f3-c434-2855-283c96782545",
"instanceName": "openapi-vm149573",
"displayName": "openapi-vm149573",
"instanceStatus": "running",
"volumeCount": 1
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.SnapshotPolicy.AccessFailed | 查询快照策略失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.SnapshotPolicy.NotFound | 快照策略查询结果为空,请确认输入的快照策略ID是否有效 |
Ecs.SnapshotPolicy.InstanceGetError | 查询快照策略绑定云主机列表失败,请重试。如果多次尝试失败,请提交工单 |