Queries all snapshots of an Elastic Compute Service (ECS) instance or a disk. When you call this operation, you can specify parameters, such as InstanceId, DiskId, SnapshotLinkId, and Status, in the request.
Operation description
You can configure multiple request parameters such as InstanceId
, DiskId
, and SnapshotIds
to query snapshots. Configured parameters have logical AND relations. Only the configured parameters are included in the filter conditions.
When you use Alibaba Cloud CLI to call an API operation, you must specify request parameter values of different data types in required formats. For more information, see Parameter format overview.
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 |
---|---|---|---|---|
ecs:DescribeSnapshots | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | No | The instance ID. | i-bp67acfmxazb4p**** |
DiskId | string | No | The disk ID. | d-bp67acfmxazb4p**** |
SnapshotLinkId | string | No | The snapshot chain ID. You can specify a JSON array that contains up to 100 snapshot chain IDs. Separate the snapshot chain IDs with commas (,). | ["sl-bp1grgphbcc9brb5****", "sl-bp1c4izumvq0i5bs****", … "sl-bp1akk7isz866dds****"] |
RegionId | string | Yes | The region ID of the disk. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
SnapshotIds | string | No | The IDs of snapshots. You can specify a JSON array that consists of up to 100 snapshot IDs. Separate the snapshot IDs with commas (,). | ["s-bp67acfmxazb4p****", "s-bp67acfmxazb5p****", … "s-bp67acfmxazb6p****"] |
PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
PageSize | integer | No | The number of entries per page. Valid values: 1 to 100. Default value: 10. | 10 |
NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You must specify the token that is obtained from the previous query as the value of NextToken. | caeba0bbb2be03f84eb48b699f0a4883 |
MaxResults | integer | No | The maximum number of entries per page. Valid values: 1 to 100. Default value: 10. | 10 |
SnapshotName | string | No | The name of the snapshot. | testSnapshotName |
Status | string | No | The status of the snapshot. Valid values:
| all |
SnapshotType | string | No | The type of the snapshot. Valid values:
| all |
Filter.1.Key | string | No | The key of filter 1 that is used to query resources. Set the value to | CreationStartTime |
Filter.2.Key | string | No | The key of filter 2 that is used to query resources. Set the value to | CreationEndTime |
Filter.1.Value | string | No | The value of filter 1 that is used to query resources. Set the value to a time. If you configure this parameter, you must also configure | 2019-12-13T17:00Z |
Filter.2.Value | string | No | The value of filter 2 that is used to query resources. Set the value to a time. If you configure this parameter, you must also configure | 2019-12-13T22:00Z |
Usage | string | No | Specifies whether the snapshot has been used to create custom images or disks. Valid values:
| none |
SourceDiskType | string | No | The source disk type of the snapshot. Valid values:
Note
The value of this parameter is case-insensitive.
| Data |
Encrypted | boolean | No | Specifies whether the snapshot is encrypted. Default value: false. | false |
ResourceGroupId | string | No | The resource group ID. If you configure this parameter to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response. Note
Resources in the default resource group are displayed in the response regardless of whether you configure this parameter.
| rg-bp67acfmxazb4p**** |
DryRun | boolean | No | Specifies whether to perform only a dry run, without performing the actual request. Valid values:
| false |
KMSKeyId | string | No | The ID of the Key Management Service (KMS) key that is used for the data disk. | 0e478b7a-4262-4802-b8cb-00d3fb40**** |
Category | string | No | The category of the snapshot. Valid values:
The local snapshot feature is replaced by the instant access feature. When you specify this parameter, take note of the following items:
Note
This parameter will be removed in the future. We recommend that you use other parameters to ensure future compatibility.
| Standard |
Tag | array<object> | No | The tags of the snapshot. | |
object | No | |||
key | string | No | The key of tag N of the snapshot. Note
This parameter will be removed in the future. We recommend that you use the Tag.N.key parameter to ensure future compatibility.
| SnapshotTest |
Key | string | No | The key of tag N of the snapshot. Valid values of N: 1 to 20 If a single tag is specified to query resources, up to 1,000 resources that have this tag added are returned. If multiple tags are specified to query resources, up to 1,000 resources that have all these tags added are returned. To query more than 1,000 resources with the specified tags, call the ListTagResources operation. | TestKey |
Value | string | No | The value of tag N of the snapshot. Valid values of N: 1 to 20. | TestValue |
value | string | No | The value of tag N of the snapshot. Note
This parameter will be removed in the future. We recommend that you use the Tag.N.Value parameter to ensure future compatibility.
| SnapshotTest |
Response parameters
Examples
Sample success responses
JSON
format
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"PageSize": 10,
"PageNumber": 1,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": 1,
"Snapshots": {
"Snapshot": [
{
"Status": "accomplished",
"CreationTime": "2020-08-20T14:52:28Z",
"Progress": "100%",
"InstantAccess": false,
"Available": false,
"RemainTime": 38,
"SourceDiskSize": "40",
"RetentionDays": 30,
"SourceDiskType": "system",
"SourceStorageType": "disk",
"Usage": "image",
"LastModifiedTime": "2020-08-25T14:18:09Z",
"Encrypted": false,
"SnapshotType": "all",
"SourceDiskId": "d-bp67acfmxazb4ph****",
"SnapshotName": "testSnapshotName",
"InstantAccessRetentionDays": 30,
"Description": "testDescription",
"SnapshotId": "s-bp67acfmxazb4p****",
"RegionId": "cn-hangzhou",
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"Category": "standard",
"KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
"SnapshotSN": "64472-116742336-61976****",
"ProductCode": "jxsc000****",
"SourceSnapshotId": "s-bp67acfmxazb4p****",
"SourceRegionId": "cn-hangzhou",
"SnapshotLinkId": "sl-bp1grgphbcc9brb5****",
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
}
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | The specified Tag.N.Key and Tag.N.Value parameters do not correspond to each other. |
400 | InvalidTagCount | The specified tags are beyond the permitted range. | The number of specified tags exceeds the upper limit. |
403 | InvalidSnapshotIds.Malformed | The amount of specified specified snapshot Ids exceeds the limit. | The specified snapshot ID is invalid. |
403 | InvalidSnapshotCategory.Malformed | The specified Category is not valid. | The specified Category parameter is invalid. |
404 | InvalidFilterKey.NotFound | The specified FilterKey is not found. | The specified filter key does not exist. |
404 | InvalidFilterValue | The specified FilterValue exceeds the limit. | The specified filter value is invalid. |
404 | InvalidUsage | The specifed Usage is not valid. | The specified Usage parameter is invalid. |
404 | InvalidSourceDiskType | The specifed SourceDiskType is not valid. | - |
404 | InvalidStatus.NotFound | The specified Status is not found. | The specified resource state does not exist. |
404 | InvalidSnapshotType.NotFound | The specfied SnapshotType is not found. | - |
404 | InvalidSnapshotLinkId.NotFound | The specified snapshot link is not found. | The specified snapshot chain does not exist. |
500 | InternalError | The request processing has failed due to some unknown error. | An internal error has occurred. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-05-22 | The Error code has changed. The response structure of the API has changed | View Change Details |
2024-02-01 | The Error code has changed. The response structure of the API has changed | View Change Details |
2023-09-18 | The Error code has changed. The response structure of the API has changed | View Change Details |