Help & DocumentationAPIsCloud Block StorageSnapshot-related APIsCreateSnapshot

CreateSnapshot

Last updated: 2020-02-03 20:14:12

Contents：

1. API Description

Domain name for API request: cbs.tencentcloudapi.com.

This API (CreateSnapshot) is used to create a snapshot of a specified cloud disk.

  • Snapshots can only be created for cloud disks with the snapshot capability. To check whether a cloud disk has the snapshot capability, see the SnapshotAbility field returned by the API DescribeDisks.
  • For the number of snapshots that can be created, please see Product Usage Restriction.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cbs.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

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 parameter. The value used for this API: CreateSnapshot
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
DiskId Yes String ID of the cloud disk, for which a snapshot needs to be created. It can be queried via the API DescribeDisks.
SnapshotName No String Snapshot name. If it is left empty, the new snapshot name is "Not named" by default.

3. Output Parameters

Parameter Name Type Description
SnapshotId String ID of the new snapshot.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Create a snapshot

Input Example

https://cbs.tencentcloudapi.com/?Action=CreateSnapshot
&DiskId=disk-lzrg2pwi
&SnapshotName=snap_201711301015
&<common request parameters>

Output Example

{
  "Response": {
    "SnapshotId": "snap-gybrif0z",
    "RequestId": "1bd35eca-0c9a-6e0b-938a-5a1f80511c19"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.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 have the snapshot capability.
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.
LimitExceeded.InstanceAttachedDisk Number of instances mounted to cloud disk exceeds the limit.
MissingParameter Missing parameter. Request does not include the required parameter.
ResourceBusy The resource is busy. Try again later.
ResourceInsufficient.OverQuota Quota insufficient.
ResourceUnavailable.TooManyCreatingSnapshot Too many snapshots created on entire network.
UnsupportedOperation.DiskEncrypt Disk is encrypted.