查询实例快照列表
更新时间:2024-12-30
该接口用于查询BEC实例快照列表信息。
请求结构
GET /v1/snapshot/insnapshot/list?pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword} HTTP/1.1
Host: bec.baidubce.com
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规范的日期格式 |
错误码
无特殊返回错误码
请求示例
GET /v1/snapshot/insnapshot/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:[
{
"insnapId": "ins-zcbwgp",
"name": "testinsnp",
"sizeInGB": 321,
"status": "created",
"createMethod": "MANUAL",
"instanceId": "vm-zljff-cn-kunming-cm-1test",
"instanceName": "test-1",
"instanceStatus": "RUNNING",
"snapshotIdList": [
"snp-cn-kunming-cm-1fq9b",
"snp-cn-kunming-cm-9nueo"
],
"cdsIdList": [
"cds-jh7p4h-rootfs",
"cds-pa6ipmpyijk6"
],
"createTime": "2024-12-30T02:15:15Z"
},
{
"insnapId": "ins-ref7re",
"name": "ins-r5r0j-20240904150742",
"sizeInGB": 40,
"status": "created",
"createMethod": "MANUAL",
"instanceId": "vm-zljff-cn-suqian-ct-2test",
"instanceName": "test-2",
"instanceStatus": "STOPPED",
"snapshotIdList": [
"snp-cn-suqian-ct-qckah"
],
"cdsIdList": [
"cds-vn9rql-rootfs"
],
"customImageId": "im-rtwajr5q",
"createTime": "2024-09-04T07:07:47Z"
},
],
"orderBy": "createTime",
"order": "desc",
"pageNo": 1,
"pageSize": 100,
"totalCount": 2
}