Domain name for API request: cbs.intl.tencentcloudapi.com.
This API is used to query the snapshot group list.
This API is used to query the snapshot group list based on snapshot group ID, snapshot group status or snapshot ID associated with the snapshot group. The relationship among different criteria is AND. For detailed filtering information, see Filter.
If the parameter is empty, a certain number of the cloud disk list for the current user is returned (specified by Limit, defaults to 20).
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: DescribeSnapshotGroups. |
| 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. |
| Filters.N | No | Array of Filter | Filter criteria. |
| Offset | No | Integer | Offset. Default value: 0. |
| Limit | No | Integer | Number of returns, with a default value of 20, and a maximum value of 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of eligible items. |
| SnapshotGroupSet | Array of SnapshotGroup | Specifies the snapshot group list 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 all snapshot group lists.
https://cbs.intl.tencentcloudapi.com/?Action=DescribeSnapshotGroups
&<Common request parameters>
{
"Response": {
"TotalCount": 2,
"RequestId": "8c068f14-5e4d-471a-ab1f-26890ada5952",
"SnapshotGroupSet": [
{
"SnapshotGroupId": "csnap-csoplz7u",
"SnapshotGroupType": "NORMAL",
"ContainRootSnapshot": true,
"SnapshotIdSet": [
"snap-31gfd8na",
"snap-patkqtz4",
"snap-1yirzaum"
],
"SnapshotGroupState": "ROLLBACKING",
"Percent": 100,
"SnapshotGroupName": "aubreyxu2",
"ModifyTime": "2020-09-22T00:00:00+00:00",
"Images": [],
"CreateTime": "2020-09-22T00:00:00+00:00",
"ImageCount": 0,
"DeadlineTime": null,
"IsPermanent": true
},
{
"SnapshotGroupId": "csnap-orard7la",
"SnapshotGroupType": "NORMAL",
"ContainRootSnapshot": true,
"SnapshotIdSet": [
"snap-50j8l0o8"
],
"SnapshotGroupState": "NORMAL",
"Percent": 100,
"SnapshotGroupName": "aubreyxu1",
"ModifyTime": "2020-09-22T00:00:00+00:00",
"Images": [
{
"ImageName": "Snapshot Group Custom Image"
"ImageId": "img-nmz7p8wt"
}
],
"CreateTime": "2020-09-22T00:00:00+00:00",
"ImageCount": 1,
"DeadlineTime": null,
"IsPermanent": true
}
]
}
}
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. |
| InvalidParameter | Incorrect parameter. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan