DescribeAutoSnapshotPolicy - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries the automatic snapshot policy.

Operation description

You can view an automatic snapshot policy that is associated with a cloud desktop in the Elastic Desktop Service (EDS) console. To view the automatic snapshot policy, you can go to the EDS console, choose Deployment > Snapshots in the left-side navigation pane, and then view an automatic snapshot policy on the Snapshots page.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
ecd:DescribeAutoSnapshotPolicy	list	All Resources ``	none	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
PolicyId	string	No	The ID of the automatic snapshot policy.	sp-c5tv9d64ebjnj****
PolicyName	string	No	The name of the automatic snapshot policy.	Test 1201
MaxResults	integer	No	The number of entries per page. Maximum value: 50. Default value: 50.	10
NextToken	string	No	The token that determines the start point of the next query. If this parameter is left empty, all results are returned.	AAAAAV3MpHK1AP0pfERHZN5pu6mqIGdPhID94rjhZFGsvpJo

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	The token that is used to start the next query. If this parameter is empty, all results haven been returned.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The ID of the request.	A7F6612E-59CC-59F9-9DD1-91867FCC****
AutoSnapshotPolicies	array<object>	The details of the queried automatic snapshot policies.
AutoSnapshotPolicy	object
TimePoints	string	The points in time at which the auto snapshots were created. The parameter values are a JSON array. Example: `["0", "1", ... "23"]`. A maximum of 24 points in time are returned. The points in time are separated with commas (,).	["17","18"]
CreationTime	string	The time when the automatic snapshot policy was created. The time follows the ISO 8601 standard in the `yyyy-mm-ddthh:mm:ssz` format. The time is displayed in UTC.	2023-01-11T09:14:00Z
Status	string	The status of the automatic snapshot policy. Valid values: Expire: The automatic snapshot policy cannot be used because you have overdue payments in your account. Normal: The automatic snapshot policy is normal.	Normal
DesktopNum	integer	The number of cloud computers to which the automatic snapshot policy is applied.	5
CronExpression	string	The cron expression that specifies when Elastic Desktop Service creates snapshots on the cloud computers.	0 0 5,7 ? * 2/2
RetentionDays	string	The retention period of the automatic snapshots. Unit: days. Valid values: 1 to 180.	3
PolicyName	string	The name of the automatic snapshot policy.	snapshot01
PolicyId	string	The ID of the automatic snapshot policy.	sp-3e3bmfcdkjfl1****
RegionId	string	The ID of the region to which the automatic snapshot policy belongs.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "A7F6612E-59CC-59F9-9DD1-91867FCC****",
  "AutoSnapshotPolicies": [
    {
      "TimePoints": [
        17,
        18
      ],
      "CreationTime": "2023-01-11T09:14:00Z",
      "Status": "Normal",
      "DesktopNum": 5,
      "CronExpression": "0 0 5,7 ? * 2/2",
      "RetentionDays": 3,
      "PolicyName": "snapshot01",
      "PolicyId": "sp-3e3bmfcdkjfl1****",
      "RegionId": "cn-hangzhou",
      "DiskType": ""
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-22	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-11-17	The response structure of the API has changed	View Change Details