1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to modify the attributes of a specified snapshot.
*Currently, only the snapshot name can be modified, and a non-permanent snapshot can be changed to a permanent one.
*The snapshot name is used only for snapshot management by users. The cloud platform does not use this name for submitting tickets or performing snapshot management operations.
Default interface request rate limit: 20 times per second.
Interface update time: 2024-07-16 07:44:51.
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: ModifySnapshotAttribute |
| 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 |
| SnapshotId | Yes | No | String | Snapshot ID. It can be queried through the DescribeSnapshots API. Example: snap-gybrif0z |
| SnapshotName | No | No | String | New snapshot name. The maximum length is 60 characters. Example: snap_201711301143 |
| IsPermanent | No | No | Bool | Retention period of the snapshot. FALSE indicates non-permanent, and TRUE indicates permanent. It only supports changing a non-permanent snapshot to a permanent one. Example: true |
| ProjectId | No | No | Int64 | New snapshot project ID. Example: 1002189 |
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. |
| InvalidSnapshotId.NotFound | The input SnapshotId does not exist. |
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| InvalidSnapshot.NotSupported | The snapshot does not support this operation. |