Query the Automatic Snapshot Policy List
Last Updated:2020-10-21
This API is used to query all automatic snapshot policies.
Request Structure
GET /v{version}/asp?marker={marker}&maxKeys={maxKeys}&aspName={aspName}&volumeName={volumeName} 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 parameter | The start position of the query for getting list by batch is a character string generated by the system |
maxKeys | int | No | Query parameter | Maximum number of master instances per page, which usually does not exceed 1,000. The default value is 1000 |
aspName | String | No | Query parameter | Automatic snapshot policy name |
volumeName | String | No | Query parameter | Disk name |
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 |
autoSnapshotPolicys | List<AutoSnapshotPolicyModel> | Automatic snapshot policy list returned |
Error Code
Without special return error code
Request Instance
GET /v2/asp?marker=asp-oG6prjrl&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": "asp-33333",
"marker": "asp-oG6prjrl",
"maxKeys": 2,
"autoSnapshotPolicys": [
{
"id": "asp-oG6prjrl",
"name": "snapshot-name",
"timePoints": [20,21],
"repeatWeekdays": [0, 6],
"retentionDays": 7,
"status": "active",
"createdTime": "2015-07-08T10:22:04Z",
"updatedTime": "2015-07-09T10:22:04Z",
"deletedTime": "1971-01-01T00:00:01Z",
"lastExecuteTime": "2015-07-09T10:22:04Z",
"volumeCount": 1
},
{
"id": "asp-22222",
"name": "snapshot-name1",
"timePoints": [23],
"repeatWeekdays": [5],
"retentionDays": 7,
"status": "active",
"createdTime": "2015-07-08T10:22:04Z",
"updatedTime": "1971-01-01T00:00:01Z",
"deletedTime": "1971-01-01T00:00:01Z",
"lastExecuteTime": "1971-01-01T00:00:01Z",
"volumeCount": 0
}
],
"isTruncated": false
}