Query the snapshot list
Updated at:2025-10-20
This API retrieves all snapshot details of a user, including snapshots from system disks and CDS data disks.
Request structure
Plain Text
1GET /v{version}/snapshot?marker={marker}&maxKeys={maxKeys}&volumeId={volumeId} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| marker | String | No | Query | The starting position for the batch list query, which is a system-generated string. |
| maxKeys | int | No | Query | The maximum number of items per page is 1,000, with a default value of 1,000. |
| volumeId | String | No | Query | Filtering can be done by disk ID; for system disks, use the instance ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| marker | String | Mark the starting position of the query. |
| isTruncated | boolean | "True" means there is more data available, and "False" means this is the last page. |
| nextMarker | String | The marker value needed to retrieve the next page. This field does not appear if isTruncated is false. |
| maxKeys | int | Maximum number of items included per page |
| snapshots | List<[SnapshotModel](BCC/API Reference/Appendix.md#SnapshotModel)> | Returned snapshot list |
Error codes
No special error codes are returned
Request example
Plain Text
1GET /v2/snapshot?marker=s-6r3dam6F&maxKeys=2 HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "nextMarker": "s-tpxSNbqb",
9 "marker": "s-6r3dam6F",
10 "maxKeys": 2,
11 "snapshots": [
12 {
13 "id": "s-6r3dam6F",
14 "createTime": "2015-07-08T10:22:04Z",
15 "name": "snapshot-name",
16 "sizeInGB": 5,
17 "status": "Available",
18 "createMethod": "MANUAL",
19 "volumeId": "v-IgJOjBWj",
20 "desc": "snapshot-decription"
21 },
22 {
23 "id": "s-UrGLpTYC",
24 "createTime": "2015-07-08T10:21:03Z",
25 "name": "snapshot-name",
26 "sizeInGB": 5,
27 "status": "Available",
28 "createMethod": "MANUAL",
29 "volumeId": "v-IgJOjBWj",
30 "desc": "snapshot-decription"
31 }
32 ],
33 "isTruncated": false
34}
