1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API (DescribeSnapshotSharePermission) is used to query the sharing information of snapshots.
Default interface request rate limit: 20 times per second.
Interface update time: 2021-04-30 07:27:23.
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: DescribeSnapshotSharePermission |
| 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 | ID of the snapshot to query, which can be accessed through DescribeSnapshots. Example: snap-j1ytqcd7 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| SharePermissionSet | Array of SharePermission | Collection of Snapshot Sharing Information Example:View |
| TotalCount | Uint64 | Total Example: 0 |
| MaxShareAccount | Uint64 | Maximum Shareable Quantity Example: 50 |
| 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. |