cbs · 2017-03-12

ModifySnapshotsSharePermission

POST

Modify snapshot sharing information.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cbs/ModifySnapshotsSharePermission 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: ModifySnapshotsSharePermission' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"AccountIds":["<AccountId>"],"Permission":"<Permission>","SnapshotIds":["<SnapshotId>"]}'

Request parameters

Field	Type	Required	Description
AccountIds	string[]	Yes	List of account IDs with which a snapshot is shared. For the format of array-type parameters, see API Introduction. You can find the account ID in Account Information.
Permission	string	Yes	Operations. Valid values: `SHARE`, sharing an image; `CANCEL`, cancelling the sharing of an image.
SnapshotIds	string[]	Yes	The ID of the snapshot. 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
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    // action-specific fields,
    "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.

SecretIdSecretKey

Request bodyvalid JSONPOST cbs.api3.convergecloud.com · ModifySnapshotsSharePermission

{
  "AccountIds": [
    "<AccountId>"
  ],
  "Permission": "<Permission>",
  "SnapshotIds": [
    "<SnapshotId>"
  ]
}

This action changes resources in my own account and may create a charge. I understand.

Behaviour

Shares a snapshot with up to 50 other accounts. Converge Cloud provides no control-plane audit trail, so shares are not recorded.