欢迎使用 云硬盘 API 3.0 版本。全新的 API 接口文档更加规范和全面,统一的参数风格和公共错误码,统一的 SDK/CLI 版本与 API 文档严格一致,给您带来简单快捷的使用体验。支持全地域就近接入让您更快连接腾讯云产品。更多腾讯云 API 3.0 使用介绍请查看:快速入门
欢迎使用腾讯云硬盘(CBS)!
云硬盘是一种高可用、高可靠、低成本、可定制化的网络块设备,具体请参考 云硬盘产品文档。
用户可以使用本文档介绍的 API 对云硬盘和快照进行相关操作,如创建弹性云盘、创建快照或回滚快照等,具体支持的操作可参见 API 概览。
请确保在使用这些接口前,已充分了解 CBS 产品、及其 使用 和 收费方式。
注意:
- 本章节云硬盘 API 接口均为最新 API 3.0 接口,后续 CBS 相关新增功能都会在此章节更新。我们强烈推荐您使用最新 API 3.0 接口。
- 现有旧版 API 接口功能依然保持,未来可能停止维护,如您仍需使用旧版接口可参考:云硬盘 API(旧版)简介。
术语表
为了让您快速熟悉云硬盘及快照服务,我们对其中的一些常用术语进行了解释,如下表:
术语 | 中文 | 说明 |
---|---|---|
CBS | 云硬盘 | 腾讯云自研的分布式块存储,详见 云硬盘产品文档 ,简称云盘,包含随云服务器购买的云硬盘和独立购买的弹性云盘两类。 |
弹性云盘 | 弹性云盘 | 不随云服务器一块购买(单独购买),拥有独立生命(计费)周期,可在不同云服务器之间自由挂载解挂的云硬盘(不支持同时在多个云服务器上挂载),也称为弹性云硬盘。 |
Snapshot | 云硬盘快照 | 保存了云硬盘在某一个时间点的副本,可以使用快照将云硬盘还原到快照创建的时间点。 |
输入参数与返回参数释义
Limit 和 Offset
用来控制分页的参数;Limit 为单次返回的最多条目数量,Offset 为偏移量。当相应结果是列表形式时,如果数量超过了 Limit 所限定的值,那么只返回 Limit 个值。
举例来说,参数 Offset=0&Limit=20 返回第 0 到 20 项,Offset=20&Limit=20 返回第 20 到 40 项,Offset=40&Limit=20 返回第 40 到 60 项;以此类推。
Ids.N
同时输入多个参数的格式。当遇到形如这样的格式时,那么该输入参数可以同时传多个。例如:
Ids.0=10.12.243.21&Ids.1=10.11.243.21&Ids.2=10.12.243.21&Ids.3=10.13.243.21...
以此类推(以下标 0 开始)。
API 快速入门
通过 API 使用弹性云盘,您需要依次完成以下三个步骤:
- 创建弹性云盘:您可以使用 CreateDisks(创建弹性云盘)接口创建弹性云盘。
- 将弹性云盘挂载到指定云服务器上:创建完弹性云盘后,使用AttachDisks(挂载弹性云盘)接口将弹性云盘挂载到指定的云服务器上。注意:这里的挂载指的是将弹性云盘分配给指定的云服务器,相当于热插了一块硬盘到服务器上。
- 登录云服务器初始化弹性云盘:初次使用新创建的弹性云盘时,需要进行分区、格式化等一系列操作。具体操作方式请见:Windows系统数据盘分区及格式化、Linux 系统分区、格式化、挂载及创建文件系统。注意,对于 Linux 系统,分区并不是必要的,您可以跳过分区直接进行格式化操作。
通过 API 使用云硬盘快照,您需要依次完成以下两个步骤:
- 创建云硬盘快照:您可以使用 CreateSnapshot(创建快照)接口对指定的云硬盘创建快照。
- 回滚云硬盘快照:在有需要时,您可以使用 ApplySnapshot(回滚快照)接口将云硬盘快照回滚到指定的云硬盘上。
使用限制
云硬盘和快照使用限制请见 云硬盘使用限制。对于具体的参数限制,请参考各接口文档中输出参数的说明。