查询快照列表
更新时间：2024-12-30
该接口用于查询用户所有的快照信息，包括系统盘快照和CDS数据盘快照信息。
请求结构
GET /v1/snapshot/list?pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword}&cdsId={cdsId}&instanceId={instanceId} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| pageNo | Integer | 否 | Query参数 | 页数，缺省值为1 |
| pageSize | Integer | 否 | Query参数 | 每每页容器服务个数，取值范围为1～100，缺省值为100 |
| keywordType | String | 否 | Query参数 | 查询关键字类型，SNAPSHOT_NAME |
| keyword | String | 否 | Query参数 | 查询的关键字值 |
| cdsId | String | 否 | Query参数 | 查询CDS ID |
| instanceId | String | 否 | Query参数 | 查询实例ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | List<SnapshotModel> | 列表数据 |
| orderBy | String | 排序字段 |
| order | String | 排序顺序 |
| pageNo | Integer | 页码 |
| pageSize | Integer | 每页结果数 |
| totalCount | Integer | 结果总数 |
SnapshotModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| snapshotId | String | 快照ID |
| name | String | 快照名称,支持大小写字母、数字、中文以及-_ /.特殊字符，必须以字母开头，长度1-65。 |
| regionId | String | 所在regionId |
| sizeInGB | int | 快照大小，单位是GB |
| status | SnapshotStatus | 快照状态。创建中creating，已创建 created，回滚中rollbacking， 删除中 deleting |
| createMethod | String | 快照创建方式，手动创建MANUAL，自动创建AUTO |
| cdsId | String | 源磁盘cdsId，为空表示相关磁盘已释放 |
| cdsName | String | 源磁盘cds名称 |
| cdsStatus | String | 源磁盘cds状态， 已挂载mounted，运行中running，创建中starting，异常exception |
| instanceId | String | 虚机实例ID，系统盘快照时有值 |
| type | String | 类型： 系统盘system，数据盘data |
| createTime | String | 快照创建时间，符合BCE规范的日期格式 |
错误码
无特殊返回错误码
请求示例
GET /v1/snapshot/list HTTP/1.1
Host: bec.baidubce.com
Authorization: auth string返回示例
HTTP/1.1 200 OK
Date: Wed, 23 Dec 2022 13:18:01 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
result:[
{
"snapshotId": "snp-amhlhhkeot9m",
"name": "test-snapshot-1",
"cdsId": "cds-85dtrvmfkxaa-rootfs",
"cdsName": "cds-vm-rootfs-system-volume",
"cdsStatus": "running",
"sizeInGB": 40,
"status": "created",
"createMethod": "MANUAL",
"type": "system",
"customImageId": "",
"createTime": "2022-11-22T07:41:13Z"
},
{
"snapshotId": "snp-vzos0ocijw4c",
"name": "test-snapshot-2",
"cdsId": "cds-cey6kbrdfxlm-rootfs",
"cdsName": "cds-vm-rootfs-system-volume",
"cdsStatus": "running",
"sizeInGB": 40,
"status": "created",
"createMethod": "MANUAL",
"type": "system",
"customImageId": "im-zjpcfuyb",
"createTime": "2022-11-17T03:18:01Z"
}
],
"orderBy": "createTime",
"order": "desc",
"pageNo": 1,
"pageSize": 100,
"totalCount": 2
}