Queries the information about enterprise-level snapshot policies. When you call this operation, you can specify parameters, such as PolicyIds, ResourceGroupId, and Tag, in the request.
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 Resources
is 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 |
---|---|---|---|---|
ebs:DescribeEnterpriseSnapshotPolicy |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
PolicyIds | array | No | The IDs of enterprise-level snapshot policies. | |
string | No | The ID of the enterprise-level snapshot policy. | esp-xxx | |
DiskIds | array | No | The IDs of disks. | |
string | No | The ID of the disk. | ["d-bp67acfmxazb4p****","d-bp67acfmxazs5t****"] | |
ResourceGroupId | string | No | The ID of the resource group. | xxx |
NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. If you specify NextToken, the PageSize and PageNumber request parameters do not take effect, and the TotalCount response parameter is invalid. | xxx |
MaxResults | integer | No | The maximum number of entries per page. | 100 |
PageSize | integer | No | The number of entries per page. | 10 |
PageNumber | integer | No | The page number. | 1 |
ClientToken | string | No | The client token that is used to ensure the idempotence of the request. | 123e4567-e89b-12d3-a456-42665544**** |
Tag | array<object> | No | The tags of the enterprise-level snapshot policies. Valid values of N: 1 to 20. | |
object | No | The tag of the policy. | ||
Key | string | Yes | The key of tag N of the enterprise-level snapshot policy. | tag-key |
Value | string | Yes | The value of tag N of the enterprise-level snapshot policy. | tag-value |
Response parameters
Examples
Sample success responses
JSON
format
{
"Policies": [
{
"Name": "xxx",
"PolicyId": "esp-xxx",
"TargetType": "DISK",
"State": "DISABLED",
"ManagedForEcs": false,
"Desc": "xxx",
"Schedule": {
"CronExpression": "1 1 1 */1 * ?"
},
"RetainRule": {
"Number": 10,
"TimeInterval": 14,
"TimeUnit": "DAYS"
},
"StorageRule": {
"EnableImmediateAccess": false
},
"CrossRegionCopyInfo": {
"Enabled": true,
"Regions": [
{
"RegionId": "cn-hangzhou",
"RetainDays": 7
}
]
},
"CreateTime": "2023-06-24T06:03:35Z",
"TargetCount": 10,
"Tags": [
{
"TagKey": "key",
"TagValue": "value"
}
],
"ResourceGroupId": "rg-xxx",
"SpecialRetainRules": {
"Enabled": true,
"Rules": [
{
"SpecialPeriodUnit": "WEEKS",
"TimeInterval": 1,
"TimeUnit": "WEEKS"
}
]
},
"DiskIds": [
"[\"d-xxx\"]"
]
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 10,
"RequestId": "5CA35A83-8D8A-5B67-BAA0-2E124F194DA4",
"NextToken": "AAAAAdDWBF2"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameter | The parameter %s is invalid. | The specified parameter value is invalid. |
400 | InvalidParameter.Conflict | The specified parameter %s and %s are not blank at the same time. | - |
400 | InvalidParameter.Format | Specified parameter format is not valid. | english description |
400 | MissingParameter | The input parameter %s that is mandatory for processing this request is not supplied. | The parameter must be specified. |
403 | Forbidden | User is not authorized to operate. | You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account. |
403 | Forbidden.Action | User is not authorized to operate this action. | You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account. |
403 | InvalidAccountStatus.NotEnoughBalance | Your account does not have enough balance. | - |
403 | LastTokenProcessing | The last token request is processing. | The value of clientToken is used in another request that is being processed. Try again later. |
403 | NoPermission.SLR | The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS. | You are not authorized to create service-linked roles. |
403 | OperationDenied | The operation is not allowed. | The operation is not supported. |
404 | InvalidApi.NotFound | Specified api is not found, please check your url and method. | - |
404 | NoSuchResource | The specified resource does not exist. | The specified resource does not exist. |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | An internal error has occurred. |
504 | RequestTimeout | The request is timeout, please try again later. | The request has timed out. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-01-08 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |