创建弹性云盘

最近更新时间:2024-10-18 11:32:38

1. 接口描述

本接口(CreateCbsStorages)用于创建新的弹性云盘。
接口请求域名:cbs.api.qcloud.com
使用限制:普通弹性云盘和 SSD 弹性云盘售卖限制请见 云硬盘使用限制

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 是否必选 类型 描述
storageType String 云硬盘介质类型。取值范围:
<li>cloudBasic:表示普通云硬盘
<li>cloudPremium:表示高性能云盘
<li>cloudSSD:表示 SSD 云硬盘
goodsNum Int 购买数量。单次请求最多可创建的云盘数有限制,具体参见 云硬盘使用限制
payMode String 付费模式,目前只有预付费prePay
period Int 购买时长,单位为月
zone string 购买的云盘所处的可用区,取值详见 地域和可用区
storageSize Int 云硬盘大小,单位为GB。
<li>如果传入snapshotId则可不传storageSize,此时新建云盘的大小为快照大小
<li>如果传入快照 ID 同时传入云盘大小,则云盘大小必须大于或等于快照大小
<li>云盘大小取值范围:普通云硬盘:10GB - 4000G;高性能云硬盘:50GB - 4000GB;SSD云硬盘:100GB - 4000GB。步长均为10GB
projectId Int 项目 ID,不带此参数时将在默认项目下进行创建。
snapshotId String 快照 ID,如果传入则根据此快照创建云盘,快照类型必须为数据盘快照,通过 DescribeSnapshots(查询快照列表)接口查询

3. 输出参数

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。详见 错误码页面
message String 错误信息,详见 错误码页面
storageIds Array[String] 创建的云硬盘 ID 列表

4. 错误码表

以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见 云硬盘错误码

错误代码 英文描述 错误描述
9003 InvalidParameter 参数错误

5. 示例

输入

https://cbs.api.qcloud.com/v2/index.php?
<公共请求参数>
$Action=CreateCbsStorages
&storageType=cloudBasic
&storageSize=10
&goodsNum=1
&period=1
&zone=ap-guangzhou-2

输出

{
    "code":"0",
    "message":"",
    "storageIds":[
            "disk-jpehowjo"
        ]
}