Introduction

Last updated: 2020-06-19 15:16:25

    Welcome to Tencent Cloud Cloud Block Storage (CBS).

    CBS is a highly available, highly reliable, low-cost, customizable network block storage device. For more information, see CBS Product Overview.

    You can use the APIs described in this documentation to perform cloud disk and snapshot actions, such as creating an elastic cloud disk, creating a snapshot, or rolling back a snapshot. For a complete list of actions, see API Overview.

    Please ensure that you are familiar with the concept of CBS, as well as its usage, and billing methods before you use these APIs.

    Note:

    All CBS APIs in this section have been upgraded to API 3.0. Future CBSfeatures will also be added here. We recommend using API 3.0.
    Legacy APIs remain available, but will not be updated. For more information, please see CBS API Overview (legacy).

    Glossary

    The following table introduces some commonly used terms in CBS to quickly familiarize you with the cloud disk and snapshot services.

    Term Full Name Description
    CBS Cloud Block Storage Distributed block storage independently developed by Tencent Cloud. CBS includes cloud disks purchased with CVMs and elastic cloud disks purchased separately. For more information, see CBS Product Overview.
    Elastic Cloud Disk Elastic Cloud Disk A cloud disk that was purchased separately from the CVM and has an independent billing cycle. It can be mounted and unmounted to different CVMs. It cannot be simultaneously mounted to multiple CVMs.
    Snapshot Cloud Disk Snapshot Used to save a copy of a cloud disk at a specific point in time. You can use the snapshot to restore the cloud disk to the point in time when the snapshot was created.

    Description of input and output parameters

    • Limit and Offset

      These parameters are used for pagination control. Limit indicates the maximum number of entries returned at a time, and Offset indicates the offset value. If the number of results exceeds the value of Limit, the number of returned results will be equal to the value of Limit.

      For example, if Offset is set to 0 and Limit is set to 20, the 0th to 19th entries are returned; if Offset is set to 20 and Limit is set to 20, the 20th to 39th entries are returned; if Offset is set to 40 and Limit is set to 20, the 40th to 59th entries are returned.

    • Ids.N

      Format for inputting multiple parameters at a time. If a parameter is in such a format, you can specify multiple values for the parameter. 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…

      N starts from 0.

    Getting Started with APIs

    The following steps describes how to use an elastic cloud disk via API:

    1. Create an elastic cloud disk: call the CreateDisks API to create an elastic cloud disk.
    2. Mount the elastic cloud disk to the specified CVM: after the elastic cloud disk is created, call the AttachDisks API to mount it to the specified CVM. Note: the term "mount" in this documentation refers to assigning the elastic cloud disk to the specified CVM, which is equivalent to hot-plugging a disk to a server.
    3. Log in to the CVM to initialize the elastic cloud disk: when using the new elastic cloud disk for the first time, you need to perform operations such as partitioning and formatting. For more information, see Initializing Data Disks (Windows CVM) and Initializing cloud disks (larger than 2TB). Note: for Linux systems, partitioning is not necessary. You can skip the partitioning process and directly proceed to formatting.

    The following steps describes how to use cloud disk snapshots via APIs:

    1. Create a cloud disk snapshot: call the CreateSnapshot API to create a snapshot of the specified cloud disk.
    2. Roll back the cloud disk snapshot: if necessary, you can call the ApplySnapshot API to roll back the snapshot to the specified cloud disk.

    Use Limits

    See CBS Use Limits for cloud disks and snapshots use limits. For limits on specific parameters, see the descriptions of output parameters in related API documents.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help