1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to create a scheduled snapshot policy.
*A maximum of 10 scheduled snapshot policies can be created in each region.
*The number and capacity of snapshots that can be created in each region are restricted. For details, see the notes on the Schedule Snapshot Policy page of the CBS console.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-28 01:10:14.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CreateAutoSnapshotPolicy |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| Policy | Yes | No | Array of Policy | Execution policy of regular snapshots. Example:View |
| AutoSnapshotPolicyName | No | No | String | Name of the regular snapshot policy to be created. If this parameter is not input, it defaults to "unnamed". The maximum length cannot exceed 60 bytes. Example: backup_data_friday |
| IsActivated | No | No | Bool | It indicates whether the regular snapshot policy is activated. FALSE indicates not activated, and TRUE indicates activated. The default value is TRUE. Example: false |
| IsPermanent | No | No | Bool | It indicates whether the snapshot created by the regular snapshot policy is permanently retained. FALSE indicates not permanently retained, and TRUE indicates permanently retained. The default value is FALSE. Example: false |
| RetentionDays | No | No | Uint64 | Retention days for snapshots created by the regular snapshot policy. The default value is 7 days. This parameter cannot conflict with the IsPermanent parameter. If the regular snapshot policy is set to retain permanently, this parameter must be set to 0.Example: 20 |
| DryRun | No | No | Bool | It indicates whether to create a regular snapshot policy. TRUE indicates only to access the start time of the backup initially, without actually creating a regular snapshot policy. FALSE indicates creating a policy. The default value is FALSE. Example: false |
| RetentionMonths | No | No | Uint64 | Number of months the snapshot created by this regular snapshot policy can be retained. This parameter cannot conflict with the IsPermanent/RetentionDays parameters. Example: 5 |
| RetentionAmount | No | No | Uint64 | Maximum number of snapshots that can be retained through this regular snapshot policy. If this number is exceeded, the earliest created snapshot will be automatically deleted. This parameter cannot conflict with the IsPermanent parameter. Example: 9 |
| AdvancedRetentionPolicy | No | No | AdvancedRetentionPolicy | Advanced retention policy for regular snapshot. This parameter cannot conflict with the IsPermanent parameter. Example:View |
| IsCrossRegion | No | No | Bool | Whether to enable cross-region snapshot replication for this scheduled snapshot policy. Default value: 0, indicating that it is disabled. Example: true |
| DestinationRegions | No | No | Array of String | Target region for cross-region snapshot replication. Example: ['region1'] |
| CrossRegionIsPermanent | No | No | Bool | Whether cross-region snapshots created based on this scheduled snapshot policy are permanently retained. Default value: 0, indicating that such snapshots are not retained permanently. Example: true |
| CrossRegionRetentionDays | No | No | Uint64 | Retention days for cross-region snapshots created by using this scheduled snapshot policy. The default value is 7 days. This parameter cannot conflict with the CrossRegionIsPermanent parameter.Example: 7 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| AutoSnapshotPolicyId | String | ID of the created regular snapshot policy. Example: asp-1lebc9r3 |
| NextTriggerTime | String | First backup start time. Example: 2018-08-08 16:00:00 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue.LimitExceeded | The parameter value is out of range |
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported. |
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| AutoSnapshotPolicyOutOfQuota | The number of regular snapshot policies has reached the upper limit. |