cbs — Cloud Block Storage
cbs · 2017-03-12
DescribeSnapshotSharePermission
POST
Query the sharing information of snapshots.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cbs/DescribeSnapshotSharePermission path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl
curl -sS https://cbs.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cbs/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: cbs.api3.convergecloud.com' \
-H 'X-TC-Action: DescribeSnapshotSharePermission' \
-H 'X-TC-Version: 2017-03-12' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"SnapshotId":"<SnapshotId>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| SnapshotId | string | Yes | The ID of the snapshot to be queried. You can obtain this by using DescribeSnapshots. |
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| SharePermissionSet | SharePermission[] | The set of snapshot sharing information |
| RequestId | string | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Success
{
"Response": {
"SharePermissionSet": …,
"RequestId": "…"
}
}Error
{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}Try it
CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cbs.
Request bodyvalid JSONPOST cbs.api3.convergecloud.com · DescribeSnapshotSharePermission
Read-only. Creates nothing.
Recorded example response
{
"TotalCount": 0,
"MaxShareAccount": 50,
"RequestId": "3311fc56-7a45-5667-9aab-55d1ed3487c3",
"SharePermissionSet": []
}