Domain name for API request: cbs.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 | No | String | Common Params. This parameter is not required for this API. |
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 | Filters. It cannot be specified together with SnapshotIds .snap-11112222 .snapshot-type .(SHARED_SNAPSHOT: a shared snapshot | PRIVATE_SNAPSHOT: a private snapshot.) |
Offset | No | Integer | Offset. Default is 0. For more information on Offset , please see relevant sections in API Introduction. |
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. |
Order | No | String | Outputs the ordering of the cloud disk list. Value range: |
OrderField | No | String | The field by which the snapshot list is sorted. Value range: By default, the snapshot list is sorted by the creation time of snapshots. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of snapshots. |
SnapshotSet | Array of Snapshot | List of snapshot details. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
NORMAL
status in Guangzhou Zone 2This example shows you how to query snapshots in NORMAL
status in Guangzhou Zone 2.
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSnapshots
<Common request parameters>
{
"Filters": [
{
"Name": "snapshot-state",
"Values": [
"NORMAL"
]
},
{
"Name": "zone",
"Values": [
"ap-guangzhou-2"
]
}
]
}
{
"Response": {
"TotalCount": 2,
"RequestId": "7974489b-8d50-4bbd-8dd2-b700bb98b8cf",
"SnapshotSet": [
{
"Tags": [],
"Placement": {
"CageId": "",
"Zone": "ap-guangzhou-2",
"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-2",
"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?