1. Interface Description
Interface request domain name: cfs.api3.convergecloud.com.
Updates the automatic scheduled snapshot policy
Default interface request rate limit: 20 times per second.
Interface update time: 2021-09-09 06:07:01.
The interface is both signature verification and authentication.
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: UpdateAutoSnapshotPolicy |
| Version | Yes | No | String | Public parameter, The value of this interface: 2019-07-19 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| AutoSnapshotPolicyId | Yes | No | String | Snapshot Policy ID Example: asp-xcweqdx |
| PolicyName | No | No | String | Snapshot policy name Example: cfspolicygz |
| DayOfWeek | Yes | No | String | Day of the week for scheduled snapshot backups Example: '1,2' |
| Hour | Yes | No | String | Hour for scheduled snapshot backups Example: '1,3,4' |
| AliveDays | No | No | Uint64 | Snapshot retention date Example: 20 |
| IsActivated | No | No | Uint64 | Indicates whether to enable the scheduled snapshot feature Example: 0 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| AutoSnapshotPolicyId | String | Snapshot Policy ID Example: asp-xcweqdx |
| 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 |
|---|---|
| UnsupportedOperation.OutOfService | Out of service due to overdue payment. Top up and try again. |
| InternalError.Timeout | Timed out. |
| UnsupportedOperation.UnverifiedUser | User not authenticated with real name. |
| AuthFailure | CAM signature/authentication error |
| UnsupportedOperation.UnauthorizedCfsQcsRole | CFS role not authorized. |
| InvalidParameter | Wrong parameter. |
| InvalidParameterValue.InvalidParamDayOfWeek | The value of DayOfWeek is invalid. |
| AuthFailure.UnauthorizedOperation | Request lacks CAM authorization. |