Welcome to Tencent Cloud CBS.

Cloud Block Storage is a highly available, high-reliability, low-cost, and customizable Network Block Device. For details, see the Cloud Block Storage product document.

Users can use the APIs described in this documentation to perform related operations on Cloud Block Storage (CBS) and snapshots, such as create elastic cloud disk, create snapshot, or rollback snapshot. For supported operations, see API overview.

Please ensure you fully understand the CBS product, and its usage and billing method before using these APIs.

Glossary

To help you quickly get familiar with Cloud Block Storage and snapshot service, we provide explanations for some common terms as shown in the table below:

Request and response parameters

• Limit and Offset

Parameter used to control paging. Limit indicates the maximum number of entries returned at once, and Offset indicates the offset. When the response is in the form of a list, if the number exceeds the Limit, only the Limit number of values are returned.

For example, the parameter Offset=0&Limit=20 returns items 0 to 20, Offset=20&Limit=20 returns items 20 to 40, Offset=40&Limit=20 returns items 40 to 60, and so on.

• Ids.N

Input multiple parameters simultaneously. When encountering such a format, the input parameter can accept multiple values. For example:

Ids.0=10.12.243.21&Ids.1=10.11.243.21&Ids.2=10.12.243.21&Ids.3=10.13.243.21...

and so on (starting from index 0).

Getting Started with APIs

Use elastic cloud disks through API, you need to complete the following three steps sequentially:

1. Create elastic cloud disk: You can use the CreateDisks (create elastic cloud disk) API to create an elastic cloud disk.
2. Mount the elastic cloud disk to the specified CVM: After creating the elastic cloud disk, use the AttachDisks (Mount Elastic Cloud Disk) API to mount the elastic cloud disk to the specified CVM. Note: Here, mounting refers to assigning the elastic cloud disk to the specified CVM, equivalent to hot-plugging a hard disk to the server.
3. Log in to the Cloud Virtual Machine to initialize the elastic cloud disk: For first-time users of a newly created elastic cloud disk, a series of operations such as partitioning and formatting are required. For specific operation methods, see: Windows system data disk partition and formatting, Linux system partitioning, formatting, mounting, and file system creation. Note that for Linux systems, partitioning is not mandatory, and you can skip partitioning to directly perform formatting.

To use a snapshot through API, you need to complete the following two steps sequentially.

1. Create a cloud disk snapshot: You can use the CreateSnapshot API to create a snapshot for the designated CBS.
2. Roll back a cloud disk snapshot: You can use the ApplySnapshot (rollback snapshot) API to roll back a cloud disk snapshot to a designated CBS.

Usage limits

For Cloud Block Storage (CBS) and snapshot usage limitations, see CBS Usage Limits. For specific parameter constraints, refer to the output parameter descriptions in each API document.