Query snapshot chain list
Updated at：2025-10-20
This API retrieves the list of snapshot chains created by the user.
Request structure
Plain Text
1GET /v{version}/snapshot/chain HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization stringRequest 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 |
| orderBy | String | No | Query | Sorting attributes, optional: chainId (snapshot chain ID, default), chainSize (snapshot chain size), volumeSize (disk size) |
| order | String | No | Query | Sorting method, optional: asc (ascending order, default), desc (descending order) |
| pageSize | int | No | Query | Count of records returned per page, defaulting to 1,000 |
| pageNo | int | No | Query | Page number, defaulting to 1 |
| volumeId | String | No | Query | Disk ID; if this field is not empty, only snapshot chain information for this disk will be returned |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| orderBy | String | Sorting attribute |
| totalCount | int | Total count of snapshot chains |
| pageSize | int | Page size |
| pageNo | int | Page number |
| isTruncated | boolean | true indicates there is more data later, false indicates it is the last page |
| snapchains | List<[SnapchainModel](BCC/API Reference/Appendix.md#SnapchainModel)> | Snapshot chain information, a collection composed of SnapchainModel objects |
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| BadRequest | Bad request parameters or illegal request. | 400 | Invalid request parameters |
| NoSuchObject | The specified object is not found or resource do not exist. | 404 | Resource does not exist |
Request example
Plain Text
1GET /v2/snapshot/chain HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deResponse 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 "orderBy": "chainSize",
9 "totalCount": 11,
10 "pageSize": 2,
11 "pageNo": 1,
12 "isTruncated": true,
13 "snapchains": [
14 {
15 "status": "active",
16 "chainSize": "20.0",
17 "chainId": "sl-IvmGOxPc",
18 "instanceId": "i-DRqFcFu8",
19 "userId": "dcc4b11a97984b62baa65d4592f4d432",
20 "volumeId": "v-IvmGOxPc",
21 "volumeSize": 40,
22 "manualSnapCount": 1,
23 "createTime": "2019-12-23T14:35:07Z",
24 "autoSnapCount": 0
25 },
26 {
27 "status": "active",
28 "chainSize": "0.0",
29 "chainId": "sl-dqH1rplQ",
30 "instanceId": "",
31 "userId": "dcc4b11a97984b62baa65d4592f4d432",
32 "volumeId": "v-dqH1rplQ",
33 "volumeSize": 50,
34 "manualSnapCount": 1,
35 "createTime": "2019-12-23T11:02:16Z",
36 "autoSnapCount": 0
37 }
38 ]
39}