1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API (ModifySnapshotsSharePermission) is used to modify snapshot sharing information.
After a snapshot is shared, the shared account can create cloud disk with that snapshot.
- Each snapshot can be shared with up to 50 accounts.
- Shared snapshots cannot have their name or description changed and can only be used for creating cloud disks.
- It supports sharing only within the same region of the recipient account.
- It only supports sharing data disk snapshots.
Default interface request rate limit: 20 times per second.
Interface update time: 2024-07-16 07:34:08.
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: ModifySnapshotsSharePermission |
| 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 |
| AccountIds | Yes | No | Array of String | ID list of accounts that receive a shared snapshot. Example: ["100001122000"] |
| Permission | Yes | No | String | Operation, including SHARE and CANCEL. SHARE indicates sharing, and CANCEL indicates canceling share. Example: SHARE |
| SnapshotIds | Yes | No | Array of String | Snapshot ID. It can be queried through the DescribeSnapshots API. Example: ["snap-4zgc8cnk"] |
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 |
|---|---|
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported. |