Domain name for API request: cbs.intl.tencentcloudapi.com.
This API is used to create a snapshot for the specified cloud disk.
SnapshotAbility field in the response.A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateSnapshot. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| DiskId | No | String | ID of the cloud disk for which to create a snapshot, which can be queried through the DescribeDisks API. |
| SnapshotName | No | String | Snapshot name. If it is not specified, "Unnamed" will be used by default. |
| Deadline | No | Timestamp ISO8601 | 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 | No | String | Backup point ID of the cbs. when input this parameter, a snapshot will be created through the backup point. the backup point ID can be obtained through the DescribeDiskBackups API query. |
| Tags.N | No | Array of Tag | Tags bound to the snapshot. |
| DiskUsage | No | String | Snapshot association cloud DISK type. valid values: SYSTEM_DISK (SYSTEM DISK), DATA_DISK (DATA DISK). optional. if left empty, the snapshot type remains consistent with the cloud DISK type. this parameter is based on some scenes where users need to create a DATA DISK snapshot from a SYSTEM DISK for shared usage. |
| Parameter Name | 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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to create a snapshot.
POST / HTTP/1.1
Host: cbs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSnapshot
<Common request parameters>
{
"SnapshotName": "snap_201711301015",
"Deadline": "2022-01-08T09:47:55+00:00",
"DiskId": "disk-lzrg2pwi"
}
{
"Response": {
"SnapshotId": "snap-gybrif0z",
"RequestId": "1bd35eca-0c9a-6e0b-938a-5a1f80511c19"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InsufficientSnapshotQuota | Insufficient snapshot quota. |
| InternalError.ComponentError | Dependent component request failed. Please contact customer service. |
| InternalError.ResourceOpFailed | The operation performed on the resource failed. For error message, see the "Message" field in error description. Try again later or contact customer service. |
| InvalidAccount.InsufficientBalance | Insufficient account balance |
| InvalidDisk.Busy | The cloud disk is busy. Try again later. |
| InvalidDisk.NotSupportSnapshot | The cloud disk does not support snapshot. |
| InvalidDisk.NotSupported | Indicates that the operation is not supported for the cloud disk. |
| InvalidDisk.SnapshotCreating | A snapshot is being created for the cloud disk. Try again later. |
| InvalidDisk.TypeError | Invalid cloud disk type. |
| InvalidDiskId.NotFound | The ‘DiskId’ entered does not exist. |
| InvalidParameter.InvalidClientToken | ClientToken is unavailable. |
| InvalidParameter.ProjectIdNotExist | The project ID does not exist. |
| LimitExceeded.InstanceAttachedDisk | Number of instances mounted to cloud disk exceeds the limit. |
| MissingParameter | Missing parameter. |
| ResourceBusy | The resource is busy. Try again later. |
| ResourceInUse | The resource is in use. |
| ResourceInUse.DiskMigrating | The cloud disk is being migrated. Try again later. |
| ResourceInUse.DiskRollbacking | The cloud disk is being rolled back. Please try again later. |
| ResourceInsufficient.OverQuota | Quota insufficient. |
| ResourceNotFound.NotFound | The resource is not found. |
| ResourceUnavailable.DiskBackupCreating | The data backup point is not created and temporarily unavailable. |
| ResourceUnavailable.DiskSnapshotChainTooLarge | The snapshot chain of the cloud disk is too long, so snapshot creation is refused. |
| ResourceUnavailable.NotSupported | The resource does not support this operation. |
| ResourceUnavailable.SnapshotCreating | Unable to use: the snapshot is being created |
| ResourceUnavailable.TooManyCreatingSnapshot | Too many snapshots are being created in the entire network. |
| UnsupportedOperation.DiskEncrypt | The disk is encrypted. |
文档反馈