Queries the details of automatic snapshot policies that are created in a specific region.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecs:DescribeAutoSnapshotPolicyEX | get | *AutoSnapshotPolicy acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/**AutoSnapshotPolicy acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/{#snapshotpolicyId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the automatic snapshot policy. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| AutoSnapshotPolicyId | string | No | The ID of the automatic snapshot policy. | sp-bp67acfmxazb4ph**** |
| AutoSnapshotPolicyName | string | No | The name of the automatic snapshot policy. | TestName |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1 | 1 |
| PageSize | integer | No | The number of entries per page. Valid values: 1 to 100. Default value: 10 | 10 |
| Tag | array<object> | No | The tags of the automatic snapshot policy. | |
| object | No | |||
| Key | string | No | The key of tag N of the automatic snapshot policy. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun. | TestKey |
| Value | string | No | The value of tag N of the automatic snapshot policy. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain http:// or https://. The tag value cannot start with acs:. | TestValue |
| ResourceGroupId | string | No | The ID of the resource group. If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response. Note
Resources in the default resource group are displayed in the response regardless of how this parameter is set.
| rg-aek2kkmhmhs**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"TotalCount": 1,
"AutoSnapshotPolicies": {
"AutoSnapshotPolicy": [
{
"TimePoints": "[\"1\"]",
"CreationTime": "2019-12-10T16:00Z",
"Status": "Normal",
"AutoSnapshotPolicyName": "testAutoSnapshotPolicyName",
"TargetCopyRegions": "test",
"CopiedSnapshotsRetentionDays": 0,
"AutoSnapshotPolicyId": "sp-bp67acfmxazb4ph****",
"RetentionDays": 7,
"RegionId": "cn-hangzhou",
"DiskNums": 1,
"EnableCrossRegionCopy": false,
"RepeatWeekdays": "[\"6\"]",
"VolumeNums": 2,
"ResourceGroupId": "rg-aek2kkmhmhs****",
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
},
"CopyEncryptionConfiguration": {
"Encrypted": false,
"KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****"
},
"Type": "Custom"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidRegionId.NotFound | The specified RegionId does not exist. | The specified region ID does not exist. |
| 400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | The specified Tag.N.Key and Tag.N.Value parameters do not correspond to each other. |
| 400 | InvalidTagCount | The specified tags are beyond the permitted range. | The number of specified tags exceeds the upper limit. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-12-02 | API Description Update. The Error code has changed | View Change Details |
| 2024-02-28 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-02-02 | The Error code has changed. The response structure of the API has changed | View Change Details |