DocsICP FilingConsole
Documentation

DescribeSnapshots

Updated at:
Copy as MD
Product
My Favorites

Queries the list and details of snapshots for a cloud desktop.

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:DescribeSnapshots

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
RegionId

string

Yes

The region ID. You can call the DescribeRegions operation to query the list of regions supported by Elastic Desktop Service.

cn-hangzhou
DesktopId

string

No

The ID of the cloud desktop.

ecd-gx2x1dhsmucyy****
DesktopName

string

No

The name of the cloud desktop.

testName
SnapshotId

string

No

The ID of the snapshot.

s-2ze81owrnv9pity4****
SnapshotName

string

No

The display name of the snapshot. The name must be 2 to 127 characters in length. It must start with a letter or a Chinese character, and can contain digits, underscores (_), and hyphens (-). To prevent name conflicts with automatic snapshots, the name cannot start with auto.

Test data disk
SourceDiskType

string

No

The type of the disk for which you want to create a snapshot.

Note

The values are not case-sensitive.

Valid values:

  • Data :

    data cloud disk.

  • System :

    system cloud disk.

system
SnapshotType

string

No

The snapshot type.

Valid values:

  • all :

    all snapshot types [default]

  • auto :

    automatic snapshots.

  • user :

    manually created snapshots.

user
OsType

string

No

The operating system type.

Valid values:

  • Linux :

    Linux operating system

  • Windows :

    Windows operating system

Windows
Creator

string

No

The creator.

Administrator
StartTime

string

No

The start time of the snapshot creation. The time is displayed in UTC and follows the ISO 8601 standard in the yyyy-mm-ddthh:mm:ssz format.

2020-11-30T06:32:31Z
EndTime

string

No

The end time of the snapshot creation. The time is displayed in UTC and follows the ISO 8601 standard in the yyyy-mm-ddthh:mm:ssz format.

2020-11-31T06:32:31Z
NextToken

string

No

The query token. Set the value to the NextToken parameter value returned by the previous API call.

8051af8d01b5479bec9f5ddf02e4a8fbd0ab6e7e43f8****
MaxResults

integer

No

The number of entries to return per page in a paging query.

10
DesktopScenario

string

No

Response elements

Element

Type

Description

Example

object

The returned information.

NextToken

string

The pagination token for the next query. If the value is empty, no more results are available.

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId

string

The ID of the request.

51592A88-0F2C-55E6-AD2C-2AD9C10D****
Snapshots

array<object>

The snapshots.

object

The snapshot information.

CreationTime

string

The time when the snapshot was created. The time is displayed in UTC and follows the ISO 8601 standard in the yyyy-mm-ddthh:mm:ssz format.

2020-12-20T14:52:28Z
Status

string

The snapshot status.

Valid values:

  • PROGRESSING :

    creating.

  • FAILED :

    creation failed.

  • ACCOMPLISHED :

    creation completed.

ACCOMPLISHED
SnapshotType

string

The snapshot type.

Valid values:

  • AUTO :

    automatically created snapshot

  • USER :

    manually created snapshot.

USER
SnapshotName

string

The name of the snapshot.

testSnapshotName
Progress

string

The creation progress of the snapshot. Unit: percentage.

100%
Description

string

The description of the snapshot.

testDescription
SnapshotId

string

The ID of the snapshot.

s-2zeipxmnhej803x7****
RemainTime

integer

The remaining time required to create the snapshot. Unit: seconds.

Note

If Status is PROGRESSING, the value of RemainTime is -1, which indicates that the remaining time is being calculated.

30
SourceDiskSize

string

The capacity of the source disk. Unit: GiB.

150
SourceDiskType

string

The type of the source disk.

Valid values:

  • SYSTEM :

    system cloud disk.

  • DATA :

    data cloud disk.

SYSTEM
DesktopId

string

The ID of the cloud desktop to which the snapshot belongs.

ecd-g03l3tlm8djoj****
DesktopName

string

The name of the cloud desktop.

test
DesktopStatus

string

The status of the cloud desktop.

Valid values:

  • Stopped :

    stopped.

  • Starting :

    starting.

  • Rebuilding :

    rebuilding.

  • Running :

    running.

  • Stopping :

    stopping.

  • Expired :

    expired.

  • Deleted :

    deleted.

  • Pending :

    pending.

Running
DiskStatus

string

The status of the disk to which the snapshot belongs.

Valid values:

  • Available :

    in use.

  • Deleted :

    deleted.

Available
Creator

string

The creator.

Administrator
ProtocolType

string

The protocol type.

Valid values:

  • HDX :

    HDX protocol.

  • ASP :

    Alibaba Cloud proprietary protocol.

ASP
OsType

string

The operating system type.

Valid values:

  • Linux :

    Linux operating system

  • Windows :

    Windows operating system

Windows
VolumeEncryptionEnabled

boolean

Indicates whether disk encryption is enabled.

false
VolumeEncryptionKey

string

The ID of the KMS key used when disk encryption is enabled. You can obtain the key ID by calling the ListKeys operation.

08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
DeletionTime

string

The time when the snapshot was created. The time is displayed in UTC+0 in the yyyy-mm-ddthh:mm:ssz format in accordance with the ISO 8601 standard.

2020-12-20T14:52:28Z

RestorePointId

string

The ID of the restore point.

rp-btgmaa20wkcju****
RestorePointName

string

The name of the restore point.

Data cloud disk backup
EnvType

string

EnvId

string

JvsId

string

Examples

Success response

JSON format

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
  "RequestId": "51592A88-0F2C-55E6-AD2C-2AD9C10D****",
  "Snapshots": [
    {
      "CreationTime": "2020-12-20T14:52:28Z",
      "Status": "ACCOMPLISHED",
      "SnapshotType": "USER",
      "SnapshotName": "testSnapshotName",
      "Progress": "100%",
      "Description": "testDescription",
      "SnapshotId": "s-2zeipxmnhej803x7****",
      "RemainTime": 30,
      "SourceDiskSize": "150",
      "SourceDiskType": "SYSTEM",
      "DesktopId": "ecd-g03l3tlm8djoj****",
      "DesktopName": "test",
      "DesktopStatus": "Running",
      "DiskStatus": "Available",
      "Creator": "Administrator",
      "ProtocolType": "ASP",
      "OsType": "Windows",
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "DeletionTime": "2020-12-20T14:52:28Z\n",
      "RestorePointId": "rp-btgmaa20wkcju****",
      "RestorePointName": "DataDiskBackup",
      "EnvType": "",
      "EnvId": "",
      "JvsId": ""
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description
403 NOT_LOGIN You are not logged in or your login token has expired.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.