cbs — Cloud Block Storage
cbs · 2017-03-12
CreateSnapshot
POST
Create a snapshot for the specified cloud disk.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cbs/CreateSnapshot 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: CreateSnapshot' \
-H 'X-TC-Version: 2017-03-12' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"DiskId":"<DiskId>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| DiskId | string | Yes | ID of the cloud disk for which to create a snapshot, which can be queried through the DescribeDisks API. |
| SnapshotName | string | No | Snapshot name. If it is not specified, "Unnamed" will be used by default. |
| Deadline | string | No | Expiration time of the snapshot. It must be in UTC ISO-8601 format, eg. 2022-01-08T09:47:55+00:00. The snapshot will be automatically deleted when it expires. |
| DiskBackupId | string | No | ID of the cloud disk backup point. When this parameter is specified, the snapshot will be created from the backup point. |
| Tags | Tag[] | No | Tags bound to the snapshot. |
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 |
|---|---|---|
| SnapshotId | string | ID of the created snapshot Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | string | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Success
{
"Response": {
"SnapshotId": …,
"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 · CreateSnapshot