接口功能介绍
查询云主机快照状态
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
无
URI
GET /v4/ecs/snapshot/status
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
snapshotID | 是 | String | 云主机快照ID, 获取: 查 查询云主机快照列表 创 创建云主机快照 |
c7a7f06d-fb0f-8d5a-e710-9262995b6b6d |
请求参数
请求头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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
snapshotStatus | String | 云主机快照状态, pending: 创建中, available: 可用, restoring: 恢复中, error:错误 |
available |
枚举参数
无
请求示例
请求url
示例:在华东1资源池查询一个云主机快照的状态信息
GET .../v4/ecs/snapshot/status?regionID=bb9fdb42056f11eda1610242ac110002&snapshotID=c7a7f06d-fb0f-8d5a-e710-9262995b6b6d
请求头header
无
请求体body
无
响应示例
{"returnObj": {"snapshotStatus": "available"},"message": "SUCCESS","description": "成功","statusCode": 800}
状态码
请参考 状态码
错误码
请参考 错误码