Domain name for API request: cbs.intl.tencentcloudapi.com.
This API (DescribeSnapshots) is used to query the details of snapshots.
Filter.Limit; the default is 20) of snapshot lists are returned to the current user.A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeSnapshots. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| SnapshotIds.N | No | Array of String | List of snapshot IDs to be queried. The parameter does not support specifying both SnapshotIds and Filters. |
| Filters.N | No | Array of Filter | Filter criteria. parameters SnapshotIds and Filters cannot be specified at the same time.
|
| Limit | No | Integer | Number of results to be returned. Default is 20. Maximum is 100. For more information on Limit, please see relevant sections in API Introduction. |
| OrderField | No | String | Field based on which the snapshot list is sorted. valid values:.
|
| Offset | No | Integer | Offset. Default is 0. For more information on Offset, please see relevant sections in API Introduction. |
| Order | No | String | Outputs the sorting order of the cloud disk list. valid values:.
|
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of snapshots. |
| SnapshotSet | Array of Snapshot | List of snapshot details. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query snapshots with status NORMAL in Guangzhou Zone 3.
POST / HTTP/1.1
Host: cbs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSnapshots
<Common request parameters>
{
"Filters": [
{
"Name": "snapshot-state",
"Values": [
"NORMAL"
]
},
{
"Name": "zone",
"Values": [
"ap-guangzhou-3"
]
}
]
}
{
"Response": {
"TotalCount": 2,
"RequestId": "7974489b-8d50-4bbd-8dd2-b700bb98b8cf",
"SnapshotSet": [
{
"Tags": [],
"Placement": {
"CageId": "",
"Zone": "ap-guangzhou-3",
"ProjectId": 0,
"CdcName": "",
"CdcId": "",
"ProjectName": "",
"DedicatedClusterId": ""
},
"CopyFromRemote": false,
"IsPermanent": true,
"DiskUsage": "DATA_DISK",
"DeadlineTime": "2023-04-09 10:45:11",
"Percent": 100,
"SnapshotId": "snap-0jfkjwl1",
"ShareReference": 0,
"SnapshotType": "PRIVATE_SNAPSHOT",
"DiskSize": 70,
"DiskId": "disk-omp7wl2m",
"SnapshotName": "TEST",
"Images": [],
"CopyingToRegions": [],
"Encrypt": false,
"CreateTime": "2023-03-09 10:45:11",
"TimeStartShare": "2023-03-09",
"ImageCount": 0,
"SnapshotState": "NORMAL"
},
{
"Tags": [],
"Placement": {
"CageId": "",
"Zone": "ap-guangzhou-3",
"ProjectId": 0,
"CdcName": "",
"CdcId": "",
"ProjectName": "",
"DedicatedClusterId": ""
},
"CopyFromRemote": false,
"IsPermanent": true,
"DiskUsage": "SYSTEM_DISK",
"DeadlineTime": "2023-04-09 10:45:11",
"Percent": 100,
"SnapshotId": "snap-obgelzpb",
"ShareReference": 0,
"SnapshotType": "PRIVATE_SNAPSHOT",
"DiskSize": 50,
"DiskId": "disk-1en5p0sq",
"SnapshotName": "test-stevenkli",
"Images": [],
"CopyingToRegions": [],
"Encrypt": false,
"CreateTime": "2023-03-08 17:12:42",
"ImageCount": 0,
"TimeStartShare": "2023-03-09",
"SnapshotState": "NORMAL"
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidFilter | The specified Filter is not supported. |
| InvalidParameterValue | Invalid parameter value. |
| MissingParameter | Missing parameter. |
| UnsupportedOperation | Unsupported operation |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback