ListSnapshots - Simple Application Server - Alibaba Cloud Documentation Center

Queries the information about snapshots that are created for a simple application server.

Operation description

The InstanceId, DiskId, SnapshotIds, and ResourceGroupId parameters are optional. However, you can specify them as filter conditions and combine them with the logical AND operator to filter snapshots that you want to query.

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

swas-open:ListSnapshots

get

*Snapshot

acs:swas-open:{#regionId}:{#accountId}:snapshot/*

*Snapshot

acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application server that corresponds to the snapshots.	cn-hangzhou
InstanceId	string	No	The ID of the simple application server.	2ad1ae67295445f598017499dc****
DiskId	string	No	The disk ID.	d-bp14wq0149cpp2xy****
SnapshotIds	string	No	The snapshot IDs. The value can be a JSON array that consists of up to 100 snapshot IDs. Separate multiple snapshot IDs with commas (,).	["s-bp16oazlsold4dks**", "s-bp16oazlsold4abc**"]
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	10
PageNumber	integer	No	The page number. Default value: 1.	1
SourceDiskType	string	No	The type of the source disk. Valid values: system: system disk. data: data disk.	Data
Tag	array<object>	No	Tag N that you want to add to the snapshot.
	object	No	The tags of the snapshot.
Key	string	No	The key of tag N that you want to add to the snapshot. A tag key can be 1 to 64 characters in length. Valid values of N: 1 to 20.	TestKey
Value	string	No	The value of tag N that you want to add to the snapshot. A tag value can be up to 64 characters in length. Valid values of N: 1 to 20.	TestValue
ResourceGroupId	string	No	The ID of the resource group.	rg-aek2bti7cf7****

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	1
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
Snapshots	array<object>	Details about the snapshots.
	array<object>	The details about snapshots.
Status	string	The status of the snapshot. Valid values: Progressing: The snapshot is being created. Accomplished: The snapshot is created. Failed: The snapshot failed to be created.	Accomplished
CreationTime	string	The time when the snapshot was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-03-09T07:12:49Z
SourceDiskId	string	The ID of the source disk. This parameter has a value even after the source disk is released.	d-bp14wq0149cpp2xy****
SnapshotName	string	The name of the snapshot.	test-SnapshotName
Progress	string	The progress of snapshot creation.	100%
Remark	string	The remarks of the snapshot.	test-Remark
SnapshotId	string	The snapshot ID.	s-bp16oazlsold4dks****
SourceDiskType	string	The type of the source disk. Valid values: system: system disk. data: data disk.	System
RegionId	string	The region ID.	cn-hangzhou
InstanceId	string	The ID of the simple application server. Note: This parameter has a value returned for only system disk snapshots.	2ad1ae67295445f598017499dc****
Tags	array<object>	The tags of the snapshot.
	object	The tags of the snapshot.
Key	string	The tag key of the snapshot.	TestKey
Value	string	The tag value of the snapshot.	TestValue
RollbackTime	string	The time when the last disk rollback was performed.	2021-03-09T07:12:49Z
ResourceGroupId	string	The ID of the resource group to which the snapshot belongs.	rg-aek2bti7cf7****

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "Snapshots": [
    {
      "Status": "Accomplished",
      "CreationTime": "2021-03-09T07:12:49Z",
      "SourceDiskId": "d-bp14wq0149cpp2xy****",
      "SnapshotName": "test-SnapshotName",
      "Progress": "100%",
      "Remark": "test-Remark",
      "SnapshotId": "s-bp16oazlsold4dks****",
      "SourceDiskType": "System",
      "RegionId": "cn-hangzhou",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "RollbackTime": "2021-03-09T07:12:49Z",
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	RegionIdNotMatchHost	The parameter regionId does not match the endpoint host.
500	InternalError	An error occurred while processing your request.
403	InvalidParam	The specified parameter value is invalid.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.
404	InvalidDiskId.NotFound	The specified DiskId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.