查询云主机快照详情
接口功能介绍
查询云主机快照详情
接口约束
- 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
URI
POST /v4/ecs/snapshot-details
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | ||
snapshotID | 是 | String | 云主机快照ID |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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 | |
results | Array of Objects | 分页明细 | results |
表 results
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
snapshotID | String | 云主机快照ID | ||
instanceID | String | 云主机ID | ||
azName | String | 可用区名称 | ||
instanceSnapshotName | String | 云主机快照名称 | ||
isMaz | Boolean | 是否适用MAZ | ||
instanceStatus | String | 云主机状态,取值范围:backingup: 备份中,creating: 创建中,expired: 已到期,freezing: 冻结中,rebuild: 重装,restarting: 重启中,running: 运行中,starting: 开机中,stopped: 已关机,stopping: 关机中,master_order_creating: 主订单未完成 | ||
customerID | String | 用户ID | ||
status | String | 云主机快照状态 | ||
description | String | 云主机快照描述 | ||
isPaas | Boolean | is_paas | ||
projectID | String | 企业项目ID | ||
deletedTime | Integer | 删除时间 | ||
expiredTime | Integer | 到期时间 | ||
createAt | String | 创建时间 | ||
updateAt | String | 更新时间 | ||
members | Array of Objects | 云硬盘及其快照详细信息 | members |
表 members
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
volume_type_name | String | 云硬盘类型,取值范围:SATA:普通IOSAS:高IOSSD:超高IOSSD-genric:通用型SSDFAST-SSD:极速型SSD | ||
volume_id | String | 云硬盘ID | ||
volume_name | String | 云硬盘名称 | ||
is_bootable | Boolean | 是否启动盘 | ||
is_encrypted | Boolean | 是否加密盘 | ||
volume_size | Integer | 云硬盘大小,单位为GB | ||
snapshot_id | String | 云硬盘快照ID | ||
snapshot_status | String | 云硬盘快照状态 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"snapshotID": "b6e2966d-7b1c-385e-abe4-d940caa273b7"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": null,
"results": [
{
"status": "available",
"instanceStatus": "Stopped",
"isMaz": false,
"instanceID": "5ae83d07-0389-22fd-def8-995090ee3d5a",
"projectID": "0",
"isPaas": false,
"deletedTime": null,
"createAt": "2022-11-02T01:41:00Z",
"expiredTime": null,
"instanceSnapshotName": "1234zhongwen",
"azName": "az1",
"snapshotID": "f39d6ef7-9aeb-773f-d59f-a48db140e9ce",
"members": [
{
"volume_type_name": "SAS",
"volume_id": "2012fece-4fd9-4195-a748-fcefc838967a",
"volume_name": "ecm-details-volume-001",
"is_bootable": false,
"is_encrypted": false,
"volume_size": 5,
"snapshot_id": "a86d5d3e-179a-4b40-b605-f14188768607",
"snapshot_status": "available"
},
{
"volume_type_name": "",
"volume_id": "7337e167-1f9a-4319-9c0f-3b598b85f494",
"volume_name": "ecm-details-volume_000",
"is_bootable": true,
"is_encrypted": false,
"volume_size": 40,
"snapshot_id": "6dadf5d5-2016-4259-8ec3-31cb2d8a26bb",
"snapshot_status": "available"
}
],
"updateAt": "2022-11-02T01:41:02Z",
"customerID": "84e0ef66-b86d-5927-b144-95f47f63a91f",
"description": "成功"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Openapi.SnapshotWorkorder.AccessFailed | 查询快照信息失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Snapshot.InfoNotFound | 未查询到云主机快照信息,请确认云主机快照是否存在 |