CreateAutoSnapshotPolicy

Last updated: 2020-02-14 18:58:40

PDF

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.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cbs.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

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 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, please see the list of regions supported by the product.
Policy.N Yes Array of Policy The policy for executing the scheduled snapshot.
AutoSnapshotPolicyName No String The name of the scheduled snapshot policy to be created. If it is left empty, the default is “Not named”. The maximum length cannot exceed 60 bytes.
IsActivated No Boolean Whether or not 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.
DryRun No Boolean Whether to create an execution policy for the scheduled snapshot. TRUE: Only the time of the initial backup needs to be obtained, and no scheduled snapshot policy is actually created. FALSE: Create. The default value is FALSE.

3. Output Parameters

Parameter Name Type Description
AutoSnapshotPolicyId String The ID of the newly created scheduled snapshot policy.
NextTriggerTime String The time that initial backup will start.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a Scheduled Snapshot Policy

Creates a scheduled snapshot policy. The cloud disk this scheduled snapshot policy is bound to will create a snapshot at 00:00 every Friday.

Input Example

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

Output Example

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

5. Developer Resources

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 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
AutoSnapshotPolicyOutOfQuota Number of scheduled snapshot policies has reached the limit.
InvalidParameterValue Invalid parameter value. Parameter value format error or parameter value not supported.
InvalidParameterValue.LimitExceeded Number of parameter values exceeds the limit.
MissingParameter Missing parameter. Request does not include the required parameter.