DescribeAutoSnapshotPolicies
1. API Description
This API is used to query the details of snapshot schedules.
2. Input Parameters
The following request parameter list only provides API request parameters.
autoSnapshotPolicyIds
No
Array of String
Filter by the ID of the snapshot schedule.
zoneIds
No
Array of String
Filter by the availability zone ID of the snapshot schedule.
autoSnapshotPolicyName
No
String
Filter by the name of the snapshot schedule.
This field supports fuzzy search.
resourceGroupId
No
String
Filter by resource group ID.
pageSize
No
Integer
Number of items in the current page result.
Default: 20.
pageNum
No
Integer
Number of pages returned.
3. Output Parameters
requestId
String
The unique request ID,
which is returned for each request. RequestId is required for locating a problem.
totalCount
Integer
The total number of matching results.
4. Code Example
Query the list of snapshot schedule.
POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeAutoSnapshotPolicies
<Common Request Params>
Request:
{}
Response:
{
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"response": {
"requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
"totalCount": 1,
"dataSet": [
{
"autoSnapshotPolicyId": "<autoSnapshotPolicyId>",
"zoneId": "asia-east-1a",
"autoSnapshotPolicyName": "Snapshot-Policy",
"repeatWeekDays": [
1,
2,
3,
4,
5,
6,
7
],
"hours": [
0
],
"retentionDays": 30,
"diskNum": 1,
"createTime": "2025-08-21T08:09:30Z",
"resourceGroup": {
"resourceGroupId": "<resourceGroupId>",
"resourceGroupName": "Default Resource Group"
},
"diskIdSet": [
"<diskId>"
]
}
]
}
}
5. Developer Resources
Zenlayer Cloud API 2.0 SDKs to make it easier for you to call APIs. More programming languages will be supported.
6. Error Codes
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
HTTP Status Code
Error Code
Description
Last updated