查询实例快照列表
更新时间：2024-12-30
该接口用于查询BEC实例快照列表信息。
请求结构
Plain Text
1 GET /v1/snapshot/insnapshot/list?pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword} HTTP/1.1
2 Host: bec.baidubce.com
3 Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| pageNo | Integer | 否 | Query参数 | 页数，缺省值为1 |
| pageSize | Integer | 否 | Query参数 | 每每页容器服务个数，取值范围为1～100，缺省值为100 |
| keywordType | String | 否 | Query参数 | 查询关键字类型：实例快照ID：INSNAP_ID, 实例快照名称：INSNAP_NAME, 实例ID： INSTANCE_ID, 快照ID： SNAPSHOT_ID |
| keyword | String | 否 | Query参数 | 查询的关键字值 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | List<InsnapshotModel> | 列表数据 |
| orderBy | String | 排序字段 |
| order | String | 排序顺序 |
| pageNo | Integer | 页码 |
| pageSize | Integer | 每页结果数 |
| totalCount | Integer | 结果总数 |
InsnapshotModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| insnapId | String | 实例快照ID |
| name | String | 快照名称,支持大小写字母、数字、中文以及-_ /.特殊字符，必须以字母开头，长度1-65。 |
| sizeInGB | int | 总大小，单位是GB |
| status | String | 实例快照状态。创建中creating，已创建 created，回滚中rollbacking， 删除中 deleting |
| createMethod | String | 快照创建方式，手动创建MANUAL，自动创建AUTO |
| instanceId | String | 实例ID |
| instanceName | String | 实例名称 |
| instanceStatus | String | 实例状态 |
| cdsIdList | Array<String> | CDS磁盘ID列表 |
| snapshotIdList | Array<String> | 磁盘快照ID列表 |
| createTime | String | 快照创建时间，符合BCE规范的日期格式 |
错误码
无特殊返回错误码
请求示例
Plain Text
1GET /v1/snapshot/insnapshot/list HTTP/1.1
2Host: bec.baidubce.com
3Authorization: auth string返回示例
JSON
1HTTP/1.1 200 OK
2Date: Wed, 23 Dec 2022 13:18:01 GMT
3Content-Type: application/json;charset=UTF-8
4Server: BWS
5
6{
7 result:[
8 {
9 "insnapId": "ins-zcbwgp",
10 "name": "testinsnp",
11 "sizeInGB": 321,
12 "status": "created",
13 "createMethod": "MANUAL",
14 "instanceId": "vm-zljff-cn-kunming-cm-1test",
15 "instanceName": "test-1",
16 "instanceStatus": "RUNNING",
17 "snapshotIdList": [
18 "snp-cn-kunming-cm-1fq9b",
19 "snp-cn-kunming-cm-9nueo"
20 ],
21 "cdsIdList": [
22 "cds-jh7p4h-rootfs",
23 "cds-pa6ipmpyijk6"
24 ],
25 "createTime": "2024-12-30T02:15:15Z"
26 },
27 {
28 "insnapId": "ins-ref7re",
29 "name": "ins-r5r0j-20240904150742",
30 "sizeInGB": 40,
31 "status": "created",
32 "createMethod": "MANUAL",
33 "instanceId": "vm-zljff-cn-suqian-ct-2test",
34 "instanceName": "test-2",
35 "instanceStatus": "STOPPED",
36 "snapshotIdList": [
37 "snp-cn-suqian-ct-qckah"
38 ],
39 "cdsIdList": [
40 "cds-vn9rql-rootfs"
41 ],
42 "customImageId": "im-rtwajr5q",
43 "createTime": "2024-09-04T07:07:47Z"
44 },
45
46],
47"orderBy": "createTime",
48"order": "desc",
49"pageNo": 1,
50"pageSize": 100,
51"totalCount": 2
52}