获取云桌面磁盘快照列表
更新时间：2024-01-26
获取云桌面磁盘快照列表
接口描述
本接口用于获取云桌面磁盘快照列表
请求结构
GET /v1/bvd/snapshot/list{?cdsId,desktopId,marker,maxKeys,name,snapshotId}
Host: bec.baidubce.com
Authorization: authorization string
X-Bce-Accesskey: accesskey请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| marker | 标记查询的起始位置 | query | false | string |
| maxKeys | 每页包含的最大数量，1-1000，默认1000 | query | false | integer |
| cdsId | 云磁盘ID | query | false | string |
| desktopId | 桌面实例ID | query | false | string |
| name | 快照名称 | query | false | string |
| snapshotId | 快照ID | query | false | string |
响应头域
除公共头域外，无其它特殊头域。
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
响应参数
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| isTruncated | true表示后面还有数据，false表示已经是最后一页 | boolean | |
| marker | 标记查询的起始位置 | string | |
| maxKeys | 每页包含的最大数量 | integer | |
| nextMarker | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 | string | |
| pageNo | 当前页号 | integer | |
| pageSize | 每页数量 | integer | |
| snapshots | 快照列表 | array | SnapshotModel |
| cdsId | 源磁盘ID | string | |
| cdsName | 源磁盘名称 | string | |
| cdsStatus | 源磁盘状态:Creating, Attaching, Detaching, Available, InUse, SnapshotProcessing, Error | string | |
| createMethod | 创建方式： MANUAL、AUTO | string | |
| instanceId | 实例ID，系统盘快照时有值 | string | |
| instanceName | 实例名称，系统盘快照时有值 | string | |
| instanceStatus | 实例状态，系统盘快照时有值。CREATING：创建中、RUNNING：运行中，STOPPED：已关机，STARTING：启动中，FAILED：异常 | string | |
| name | 快照名称 | string | |
| sizeInGB | 源磁盘容量 | integer | |
| snapshotId | 快照ID | string | |
| status | 快照状态： creating、 created、 imaging、 rollbacking、 deleting、error | string | |
| type | 类型： system：系统盘、 data：数据盘 | string | |
| createTime | 创建时间 | string | |
| totalCount | 总数 | integer |
错误码
请参照错误返回章节的内容。
请求示例
GET /v1/bvd/snapshot/list HTTP/1.1
Host: bec.baidubce.com
Authorization: bce-auth-v1/xxxxx响应示例
{
"isTruncated": false,
"maxKeys": 1000,
"totalCount": 1,
"snapshots": [
{
"snapshotId": "snp-cn-baoding-un-ygd3kvlmst9i",
"name": "sys",
"cdsId": "cds-vd-yr7oqp-rootfs",
"cdsName": "sys",
"cdsStatus": "InUse",
"sizeInGB": 100,
"status": "created",
"createMethod": "MANUAL",
"type": "system",
"instanceId": "vd-zgzfg-cn-baoding-un-zfsag",
"instanceName": "test",
"instanceStatus": "RUNNING",
"createTime": "2024-01-09T11:14:44Z"
}
]
}