1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API (ModifyAutoSnapshotPolicyAttribute) is used to modify the attributes of regular snapshot policies.
- You can call this API to modify the execution policy, name, and whether to activate, among other attributes of the regular snapshot policy.
- When modifying the retention days, ensure there is no conflict with the permanent retention attribute; otherwise, the whole operation fails and a specific error code is returned.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-17 19:43:46.
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: ModifyAutoSnapshotPolicyAttribute |
| 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 |
| AutoSnapshotPolicyId | Yes | No | String | Regular snapshot policy ID. Example: asp-nqu08k2l |
| Policy | No | 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: data_disk_auto_snapshot |
| 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: 1 |
| 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: TRUE |
| RetentionDays | No | No | Uint64 | Retention days for snapshots created by the regular snapshot policy. This parameter cannot conflict with the IsPermanent parameter. That is, if the regular snapshot policy is set to retain permanently, RetentionDays must be set to 0.Example: 6 |
| 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: 6 |
| 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: 6 |
| 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. The default value is 0, indicating that it is disabled. Example: true |
| UnsetAdvancedRetentionPolicy | No | No | Bool | Whether to delete the advanced snapshot policy. Example: true |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| 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 | 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. |
| InvalidSnapshot.NotSupported | The snapshot does not support this operation. |
| InvalidAutoSnapshotPolicyId.NotFound | The input AutoSnapshotPolicyId does not exist. |