All Products
Search

This Product

    Elastic Desktop Service:DescribeAutoSnapshotPolicy

    Document Center

    Elastic Desktop Service:DescribeAutoSnapshotPolicy

    Last Updated:May 12, 2026

    Queries the details of automatic snapshot policies.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ecd:DescribeAutoSnapshotPolicy

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. To query the regions supported by Elastic Desktop Service, call the DescribeRegions operation.

    cn-hangzhou
    PolicyId

    string

    No

    The ID of the automatic snapshot policy.

    sp-c5tv9d64ebjnj****
    PolicyName

    string

    No

    The name of the automatic snapshot policy.

    测试1201
    MaxResults

    integer

    No

    The maximum number of entries to return per page.

    • Maximum value: 50

    • Default value: 50

    10
    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.

    AAAAAV3MpHK1AP0pfERHZN5pu6mqIGdPhID94rjhZFGsvpJo

    Response elements

    Element

    Type

    Description

    Example

    object

    NextToken

    string

    The pagination token that is used in the next request to retrieve a new page of results. If the return value is empty, no more results are returned.

    caeba0bbb2be03f84eb48b699f0a4883
    RequestId

    string

    The request ID.

    A7F6612E-59CC-59F9-9DD1-91867FCC****
    AutoSnapshotPolicies

    array<object>

    The automatic snapshot policies.

    object

    An automatic snapshot policy.

    TimePoints

    string

    The points in time when automatic snapshots are created.

    The value is a JSON array of integers. Example: ["0", "1", ... "23"]. A maximum of 24 points in time can be specified.

    ["17","18"]
    CreationTime

    string

    The time when the 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 policy cannot be used due to overdue payments.

    • Normal :

      The policy is normal.

    Normal
    DesktopNum

    integer

    The number of cloud computers to which the automatic snapshot policy is applied.

    1
    CronExpression

    string

    The cron expression that is used to create snapshots.

    0 0 5,7 ? * 2/2
    RetentionDays

    string

    The retention period of automatic snapshots. Unit: days. Valid values: 1 to 180.

    2
    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 where the automatic snapshot policy resides.

    cn-hangzhou
    DiskType

    string

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.