Query a Snapshot List
Last Updated:2020-07-20
This API is used to query all snapshot information, including system disk snapshot and CDS disk snapshot information.
Request Structure
GET /v{version}/snapshot?marker={marker}&maxKeys={maxKeys}&volumeId={volumeId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
Request Header Field
There are no other special header fields except the public header field.
Request Parameters
Parameter Name | Type | Required? | Parameter Position | Description |
---|---|---|---|---|
version | String | Yes | URL parameter | API version number |
marker | String | No | Query parameters | The start position of query to obtain the list by batch, which is a character string generated by the system. |
maxKeys | int | No | Query parameters | Maximum number of master instances per page, which usually does not exceed 1,000. The default value is 1000. |
volumeId | String | No | Query parameters | If it is filtered through the disk ID, the system disk is the instance ID. |
Return Header Field
There are no other special header fields except the common header field.
Return Parameter
Parameter Name | Type | Description |
---|---|---|
marker | String | Mark the starting position of the query |
isTruncated | boolean | True means there is still data behind, and false means it is already the last page. |
nextMarker | String | Get the marker value to be passed on the next page. This field does not appear when “isTruncated” is false. |
maxKeys | int | Maximum number of master instances per page |
snapshots | List<SnapshotModel> | Snapshot list returned |
Error Code
Without special return error code
Request Instance
GET /v2/snapshot?marker=s-6r3dam6F&maxKeys=2 HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
Return Instance
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"nextMarker": "s-tpxSNbqb",
"marker": "s-6r3dam6F",
"maxKeys": 2,
"snapshots": [
{
"id": "s-6r3dam6F",
"createTime": "2015-07-08T10:22:04Z",
"name": "snapshot-name",
"sizeInGB": 5,
"status": "Available",
"createMethod": "MANUAL",
"volumeId": "v-IgJOjBWj",
"desc": "snapshot-decription"
},
{
"id": "s-UrGLpTYC",
"createTime": "2015-07-08T10:21:03Z",
"name": "snapshot-name",
"sizeInGB": 5,
"status": "Available",
"createMethod": "MANUAL",
"volumeId": "v-IgJOjBWj",
"desc": "snapshot-decription"
}
],
"isTruncated": false
}