接口功能介绍
查询云主机快照详情
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
无
URI
GET /v4/ecs/snapshot/details
路径参数
无
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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| results | Array of Objects | 分页明细 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| snapshotID | String | 云主机快照ID | c7a7f06d-fb0f-8d5a-e710-9262995b6b6d | |
| instanceID | String | 云主机ID | 34912472-f7b9-99c5-9f68-e454d4e19fd2 | |
| instanceName | String | 云主机名称 | openapi-vm833508 | |
| azName | String | 可用区名称 | acn-huadong1-jsnj1A-public-ctcloud | |
| snapshotName | String | 云主机快照名称 | changeName3 | |
| instanceStatus | String | 云主机状态，取值范围： backingup: 备份中， creating: 创建中， expired: 已到期， freezing: 已冻结， rebuild: 重装， restarting: 重启中， running: 运行中， starting: 开机中， stopped: 已关机， stopping: 关机中， error: 错误， snapshotting: 快照创建中， unsubscribed: 包周期已退订， unsubscribing: 包周期退订中。 更多云主机状态请通过状态枚举值查看云主机使用状态 |
running | |
| snapshotStatus | String | 云主机快照状态， pending: 创建中, available: 可用， restoring: 恢复中， error：错误 |
available | |
| snapshotDescription | String | 云主机快照描述 | 描述2 | |
| projectID | String | 企业项目ID | 0 | |
| createdTime | String | 创建时间 | 2023-03-07 T08:55:13Z | |
| updatedTime | String | 更新时间 | 2023-03-11 T02:45:01Z | |
| imageID | String | 云主机镜像ID | b78812b0-ff50-4816-b58f-5c4fbc230b08 | |
| memory | Integer | 云主机内存大小，单位 MB | 2048 | |
| cpu | Integer | 云主机cpu核数 | 1 | |
| flavorID | String | 云主机规格ID | 5f3ba144-98e4-ea85-ea9b-933394dded33 | |
| members | Array of Objects | 云主机的云硬盘及其快照详细信息 | members |
表 members
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskType | String | 云硬盘类型 SATA/SAS/SSD-genric/SSD/FAST-SSD | SATA | |
| diskID | String | 云硬盘ID | 278f05e9-3ce6-40ad-bbb2-37ddb19aea1d | |
| diskName | String | 云硬盘名称 | ecm-test02-volume_000 | |
| isBootable | Boolean | 是否是可启动磁盘,取值范围： false：非启动盘 true：可启动盘 |
true | |
| isEncrypt | Boolean | 是否加密盘，取值范围： false：不加密， true：加密， 默认值为false |
false | |
| diskSize | Integer | 云硬盘大小 | 40 | |
| diskSnapshotID | String | 云硬盘快照ID | 9b6873a3-e270-41e9-91d5-e1d04394da0a | |
| diskSnapshotStatus | String | 云硬盘快照状态 | available |
枚举参数
无
请求示例
请求url
示例：在华东1资源池查询一个快照的详情GET .../v4/ecs/snapshot/details?regionID=bb9fdb42056f11eda1610242ac110002&snapshotID=c7a7f06d-fb0f-8d5a-e710-9262995b6b6d
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"results": [{
"snapshotID": "c7a7f06d-fb0f-8d5a-e710-9262995b6b6d",
"instanceID": "34912472-f7b9-99c5-9f68-e454d4e19fd2",
"instanceName": "openapi-vm833508",
"azName": "cn-huadong1-jsnj1A-public-ctcloud",
"snapshotName": "changeName3",
"instanceStatus": "running",
"snapshotStatus ": "available",
"snapshotDescription ": "描述2",
"projectID ": "0",
"createdTime ": "2023-03-07 T08:55:13Z",
"updatedTime ": "2023-03-11 T02:45:01Z",
"imageID": "b78812b0-ff50-4816-b58f-5c4fbc230b08",
"memory": 2048,
"cpu": 1,
"flavorID": "5f3ba144-98e4-ea85-ea9b-933394dded33",
"members ": [
{
"diskType ": "SATA",
"diskID ": "278f05e9-3ce6-40ad-bbb2-37ddb19aea1d",
"diskName ": "ecm-test02-volume_000",
"isBootable ": true,
"isEncrypt ": false,
"diskSize ": 40,
"diskSnapshotID ": "9b6873a3-e270-41e9-91d5-e1d04394da0a",
"diskSnapshotStatus ": "available"},
{
"diskType ": "SATA",
"diskID ": "62c2a8e8-0053-4c2f-93c8-78f132e39732",
"diskName ": "ecm-test02-volume-001",
"isBootable ": false,
"isEncrypt ": false,
"diskSize ": 5,
"diskSnapshotID ": "74da25f1-5158-424e-a0fe-f407e14c8d25",
"diskSnapshotStatus ": "available"}]}]},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
