CreateAutoSnapshotPolicy

Last updated: 2019-09-09 20:17:31

1. API Description

Domain name for API request: cbs.tencentcloudapi.com.

This API (CreateAutoSnapshotPolicy) is used to create a scheduled snapshot policy.

  • For the limits on the number of scheduled snapshot policies that can be created in each region, see Scheduled Snapshots.
  • The quantity and capacity of the snapshots that can be created in each region are limited. For more information, see the Snapshots page on the Tencent Cloud Console. If the number of snapshots exceeds the quota, the creation of the scheduled snapshots will fail.

Default request rate limit: 20/sec.

Note: This API supports Finance regions. Finance and non-Finance regions are isolated from each other. Therefore, if the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region specified in the Region field, for example: cbs.ap-shanghai-fsi.tencentcloudapi.com.

2. Input Parameters

The list below contains only the API request parameters and certain common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateAutoSnapshotPolicy
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, see List of Regions supported by the product.
Policy.N Yes Array of Policy The execution policy for scheduled snapshots.
AutoSnapshotPolicyName No String Name of the scheduled snapshot policy to create. If it is not specified, the default is “Not Named”. The length cannot exceed 60 characters.
IsActivated No Boolean Whether the scheduled snapshot policy is activated. FALSE: Not activated. True: Activated. The default value is TRUE.
IsPermanent No Boolean Whether the snapshot created by this scheduled snapshot policy is retained permanently. FALSE: Not retained permanently. TRUE: Retained permanently. The default value is FALSE.
RetentionDays No Integer The number of days that a snapshot created by this scheduled snapshot policy is retained. The default value is 7. If this parameter is specified, the IsPermanent input parameter can not be TRUE, otherwise a conflict will occur. I
DryRun No Boolean Whether to create an execution policy for the scheduled snapshot. TRUE: Only obtain the time of the first snapshot but not to create a scheduled snapshot policy. FALSE: Create a scheduled snapshot policy. The default value is FALSE.

3. Output Parameters

Parameter Name Type Description
AutoSnapshotPolicyId String ID of the newly created scheduled snapshot policy
NextTriggerTime String The time of first snapshot backup
RequestId String Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Sample 1. Creating a Scheduled Snapshot Policy

Create a scheduled snapshot policy. The cloud disk that is bound to the scheduled snapshot policy will create a snapshot every Friday at 00:00.

Input Sample Code

https://cbs.tencentcloudapi.com/?Action=CreateAutoSnapshotPolicy
&AutoSnapshotPolicyName=backup_data_friday
&Policy.0.DayOfWeek.0=4
&Policy.0.Hour.0=0
&<Common request parameters>

Output Sample Code

{
  "Response": {
    "AutoSnapshotPolicyId": "asp-1lebc9r3",
    "NextTriggerTime": "2018-08-08 16:00:00",
    "RequestId": "88d95732-c4e9-bd97-4a23-5a1f978d3b72"
  }
}

5. Resources for Developers

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 comes with SDKs that support multiple programming languages and make it easier to call the APIs.

Command line tools

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
AutoSnapshotPolicyOutOfQuota The number of scheduled snapshot policies has reached the limit.
InvalidParameterValue Invalid parameter value. Parameter value is in an incorrect format or is not supported.
InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
MissingParameter Missing parameter. A required parameter is missing in the request.