Queries the information about snapshots that are created for a simple application server.
Operation description
You can specify multiple request parameters such as InstanceId, DiskId, and SnapshotIds to query snapshots. Specified parameters have logical AND relations. Only the specified parameters are included in the filter conditions.
QPS limit
You can call this API operation up to 10 times per minute per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.
Debugging
Authorization information
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 |
| Tag | object [] | No | The tags of the snapshot. | |
| Key | string | No | The key of tag N to be added to the snapshot. Valid values of N: 1 to 20. | TestKey |
| Value | string | No | The value of tag N to be added to the snapshot. Valid values of N: 1 to 20. | TestValue |
Response parameters
Examples
Sample success responses
JSONformat
{
"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"
}
]
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | RegionIdNotMatchHost | The parameter regionId does not match the endpoint host. |
| 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. |
| 500 | InternalError | An error occurred while processing your request. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2024-02-20 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||||||||||||
| ||||||||||||||||||||
| 2023-09-20 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||
| ||||||||||||||||||||
| 2023-09-18 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||
| ||||||||||||||||||||
| 2023-05-25 | API Description Update. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||||||||||||
|