Elastic Compute Service
Elastic Compute Service
Document
- Documentation
Elastic Compute ServiceElastic Compute ServiceAPI ReferenceSnapshotAuto snapshot policyDescribeAutoSnapshotPolicy - Query automatic snapshot policy
Copy page
Download PDFAuto snapshot policy
DescribeAutoSnapshotPolicy - Query automatic snapshot policy
Copy pageDownload PDFDescribeAutoSnapshotPolicy - Query automatic snapshot policy
Call the DescribeAutoSnapshotPolicy API to query all created automatic snapshot policies that match your criteria in a specific region.
Debugging
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
request parameters
Only unique request parameters and some common parameters for this API are listed below. For more information, see Common Parameters.
Action string required Example: DescribeAutoSnapshotPolicy
Operation to perform: DescribeAutoSnapshotPolicy.
Version string required Example value: 2020-04-01
The version of the API is: 2020-04-01.
PageSize integer Optional Example: 10
Page size, maximum 100; the default is 15.
PageNumber integer Optional Example: 1
Starting page number, default is 1.
TagFilters.N.Key string[] Optional Example value: TagFilters.1.Key=tag
Specifying the tag key when querying resources by tags. Description as follows:
- TagFilters.N.Key: N indicates the index number of the tag key. Value range: 1~10.
- Separate multiple tag keys using &. Duplicate entries are not allowed.
- If this parameter is not provided, it implies querying all tags.
- When an empty string is passed, the error code InvalidTagFilterKey.Malformed is returned.
TagFilters.N.Values.N string[] Optional Example: TagFilters.1.Values.1=tag&TagFilters.1.Values.2=test
Specifies the tag value when querying resources by tags. Description as follows:
- TagFilters.N.Values.N: The first N indicates the sequence number of the tag key. Value range: 1~10.
- TagFilters.N.Values.N: The second N indicates the sequence number of the tag value. Value range: 1 to 3.
- Separate multiple tag values with &.
- If this parameter is passed in, you must first pass in TagFilters.N.Key.
- Not providing this parameter means querying all tag values under the same tag key.
- When an empty string is entered, it means querying tags with empty tag values.
AutoSnapshotPolicyIds.N string[] Optional Example: AutoSnapshotPolicyIds.1=asp-anj249wubz9kakc8**** AutoSnapshotPolicyIds.2=asp-ancejlwubz9kakc8****
List of automatic snapshot policy IDs to query.
ProjectName string Optional Example: default
The project associated with the auto snapshot policy.
Response Parameters
Only unique response parameters for this API are listed below. For more information, see Response Structure.
PageSize integer Example value: 15
Page size.
PageNumber integer Example: 1
Page number.
TotalCount integer Example value: 3
Total number of automatic snapshot policies.
AutoSnapshotPolicies object[] Example: -
List of automatic snapshot policies.
AutoSnapshotPolicyId string Example: asp-anj249wubz9kakc8****
Auto snapshot policy ID.
Status string Example: /
Reserved parameter.
RepeatDays integer Example value: 2
Create snapshots on a daily interval, that is, create snapshots every specified number of days
UpdatedAt string Example value: 2021-06-28T15:10:47+08:00
Last updated time of the automatic snapshot policy
CreatedAt string Example: 2021-06-28T15:10:47+08:00
Creation time of the automatic snapshot policy
ProjectName string Example: default
Project to which the automatic snapshot policy belongs.
TimePoints string[] Example: "2", "8", "9"
Creation time points for automatic snapshots.
RepeatWeekdays string[] Example values: "3", "5", "7"
Create snapshots on a weekly basis by selecting one or more days between Monday and Sunday.
RetentionDays integer Example value: 50
The retention period for automatic snapshots, measured in days, is defined as follows:
- -1: Save permanently.
- 1~65536: Specify the number of days to retain.
VolumeNums integer Example: 1
Total number of volumes.
AutoSnapshotPolicyName string Example: testName
Name of the automatic snapshot policy.
Tags object[] Example: /
Tag.
Key string Example value: tag
Tag key for the automatic snapshot policy.
Value string Example: test
Tag values for automatic snapshot policy.
Request example
GET /?Action=DescribeAutoSnapshotPolicy&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs
Back to example
{
"ResponseMetadata": {
"RequestId": "2022050518000501021206303202BF****",
"Action": "DescribeAutoSnapshotPolicy",
"Version": "2020-04-01",
"Service": "storage_ebs",
"Region": "cn-beijing"
},
"Result": {
"AutoSnapshotPolicies": [
{
"AccountId": "200000****",
"AutoSnapshotPolicyId": "asp-anj1nuju6w9gsaqi****",
"AutoSnapshotPolicyName": "modify_****autosanpshot_policy",
"CreatedAt": "2022-04-28T18:46:36+08:00",
"ProjectName": "default",
"RepeatWeekdays": [
"3",
"5",
"7"
],
"RetentionDays": 50,
"Status": "",
"TimePoIntegers": [
"2",
"8",
"9"
],
"UpdatedAt": "2022-04-28T18:46:37+08:00",
"VolumeNums": 0
},
{
"AccountId": "200000****",
"AutoSnapshotPolicyId": "asp-anj2a9gwj49gsbso****",
"AutoSnapshotPolicyName": "****test",
"CreatedAt": "2022-04-28T14:49:01+08:00",
"ProjectName": "",
"RepeatWeekdays": [
"1"
],
"RetentionDays": -1,
"Status": "",
"TimePoIntegers": [
"0"
],
"UpdatedAt": "2022-04-28T14:49:01+08:00",
"VolumeNums": 0
}
],
"PageNumber": 1,
"PageSize": 10,
"RequestId": "2022050518000501021206303202BFE158-cc****",
"TotalCount": 2
}
}
error code
The table below lists the error codes related to business logic for this API. For public error codes, see the Public Error Codes documentation.
Status code | error code | error message | Create Volume |
400 | InvalidRequest | The operation is not permitted due to the request is invalid. | Invalid request. |
400 | ErrMaximumTagFilterKeys | too many tag filter keys | The tag filter key exceeds the limit |
400 | ErrTagFilterKeyConflict | tag filter key conflict | Label filter key conflict. |
400 | ErrInvalidTagFilterKey | tag filter key invalid | Tag filter key is invalid |
400 | ErrMaximumTagFilterValues | too many tag filter value | Tag filter value exceeds the limit |
400 | ErrInvalidTagFilterValue | tag filter value invalid | Tag filter value is invalid. |
400 | ErrInvalidAccountId | account id invalid | Account ID is invalid |
Last updated: 2026.01.09 18:19:56
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
