1. API Description
Domain name for API request: cbs.tencentcloudapi.com.
This API (DescribeDiskAssociatedAutoSnapshotPolicy) is used to query the scheduled snapshot policy bound to a cloud disk.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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: DescribeDiskAssociatedAutoSnapshotPolicy. |
| 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. |
| DiskId |
Yes |
String |
The ID of the queried cloud disk. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| TotalCount |
Integer |
The quantity of scheduled snapshots binded to cloud disk. |
| AutoSnapshotPolicySet |
Array of AutoSnapshotPolicy |
List of scheduled snapshots bound to cloud disk. |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying the scheduled snapshot policies associated with a cloud disk whose ID is disk-dw0bbzws
This example shows you how to query the scheduled snapshot policies associated with a cloud disk by cloud disk ID.
https:
&DiskId=disk-dw0bbzws
&<Common request parameters>
Output Example
{
"Response": {
"AutoSnapshotPolicySet": [
{
"DiskIdSet": [],
"IsActivated": true,
"AdvancedRetentionPolicy": null,
"IsCopyToRemote": 0,
"IsPermanent": false,
"AutoSnapshotPolicyState": "NORMAL",
"NextTriggerTime": "2023-02-24 23:00:00",
"AutoSnapshotPolicyName": "Orch-data-1h-3d",
"AutoSnapshotPolicyId": "asp-3drodm1k",
"CopyFromAccountUin": null,
"InstanceIdSet": [],
"RetentionAmount": 0,
"RetentionDays": 3,
"Policy": [
{
"DayOfWeek": [
0,
1,
2,
3,
4,
5,
6
],
"Hour": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
]
}
],
"RetentionMonths": 0,
"CreateTime": "2023-02-15 16:56:04",
"CopyToAccountUin": null
}
],
"TotalCount": 1,
"RequestId": "a9f6fd41-242f-4053-89c2-73ac5465ed9c"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| InvalidParameterValue |
Invalid parameter value. |
| MissingParameter |
Missing parameter. |
| UnsupportedOperation |
Unsupported operation |