创建云硬盘
更新时间 2025-08-05 16:38:35
最近更新时间: 2025-08-05 16:38:35
2017三月SUV汽车销量排行 合资品牌销量一个字惨
百度 ”和，是天下之大道。支持按需/包年包月创建云硬盘。
接口约束
1、用户云硬盘配额未满。
2、用户账户余额充足，该接口无法使用优惠券支付，若余额不足会创建一个待支付订单。
接口是否审批
否
URI
POST JSON /v4/ebs/new-ebs
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。 | 20230211ebsspec7 | |
| regionID | 是 | String | 资源池ID。 | 81f7728662dd11ec810800155d307d5b | |
| multiAttach | 否 | Boolean | 是否多云主机挂载，取值范围： ●true：是 ●false：否 默认值：false | false | |
| isEncrypt | 否 | Boolean | 是否加密盘，取值范围： ●true：是 ●false：否 默认值：false 共享盘、ISCSI模式磁盘、极速型SSD类型盘、XSSD系列盘不支持加密。 | false | |
| kmsUUID | 否 | String | 如果是加密盘，需要提供kms的uuid。 | 111d979e-5f30-4dd6-a167-c8c8cdd8aa7c | |
| projectID | 否 | String | 企业项目ID，默认为0。 | 0 | |
| diskMode | 是 | String | 云硬盘磁盘模式，分为： ●VBD（Virtual Block Device）：虚拟块存储设备。 ●ISCSI （Internet Small Computer System Interface）：小型计算机系统接口。 ●FCSAN（Fibre Channel SAN）：光纤通道协议的SAN网络。 | VBD | |
| diskType | 是 | String | 云硬盘类型及相关限制： ●SATA：普通IO ●SAS：高IO，只有该类型支持FCSAN模式 ●SSD：超高IO ●FAST-SSD：极速型SSD，不支持ISCSI模式 ●XSSD-0、XSSD-1、XSSD-2：X系列云硬盘，不支持加密，不支持ISCSI模式或FCSAN模式 | SATA | |
| diskName | 是 | String | 磁盘命名，单账户单资源池下，命名需唯一。 仅允许英文字母、数字及_或者-，长度为2-63字符，不能以特殊字符开头。 | ebs-newspec-test0211v7 | |
| diskSize | 是 | Integer | 云硬盘大小，单位GB。数据盘的取值范围： ●XSSD-0：10GB-65536GB | 10 | |
| onDemand | 否 | Boolean | 是否按需下单，取值范围： ●true：是 ●false：否 默认值：true | false | |
| cycleType | 否 | String | 包周期类型，year：年，month：月。 onDemand为false时，必须指定year和month的值。 | month | |
| cycleCount | 否 | Integer | 包周期数。onDemand为false时必须指定。 周期为年（year）时，周期最大长度不能超过5年。 周期为月（month）时，周期最大长度不能超过60月。 | 1 | |
| imageID | 否 | String | 镜像ID，如果用镜像创建，只支持数据盘的私有镜像，所创建的数据盘的所在地域要与镜像源一致，容量不可小于镜像对应的磁盘容量。 不支持批量创建操作，从镜像创建的数据盘不支持加密、ISCSI和FCSAN高级配置。 | sjsidfnsdfsf | |
| azName | 否 | String | 多可用区资源池下，必须指定可用区。 | az2 | |
| provisionedIops | 否 | Integer | XSSD类型盘的预配置iops值，最小值为1，其他类型的盘不支持设置。具体取值范围如下： ●XSSD-0：（基础IOPS（min{1800+12×容量， 10000}） + 预配置IOPS） ≤ min{500×容量，50000} | 1 | |
| deleteSnapWithEbs | 否 | Boolean | 设置全部快照是否随盘删除，取值范围： ●true：是 ●false：否 默认值：false | false | |
| labels | 否 | Array of Objects | 设置云硬盘标签，实际绑定标签的结果请查询云硬盘详情的labels返回值是否如预期。 | [{"key":"xxxx","value":"xxxx"}] | labels |
| backupID | 否 | String | 云硬盘备份ID参数，有以下限制： ●从备份创建盘仅支持VBD模式。 ●新盘容量不能小于备份源盘容量。 ●不支持配置加密属性（自动与备份源盘保持一致）。 ●备份状态必须是可用。 | 0ae97ef5-6ee2-44af-9d05-1a509b0a1be6 |
表 labels
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| key | 是 | String | 标签的key值，长度不能超过32个字符。 | 32ff | |
| value | 是 | String | 标签的value值，长度不能超过32个字符。 | fe33 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中/失败)。 | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述。 | get volume failed | |
| description | String | 成功或失败时的描述，一般为中文描述。 | 获取盘信息失败 | |
| returnObj | Object | 返回数据结构体。 | returnObj | |
| errorCode | String | 业务细分码，为Product.Module.Code三段式码.请参考错误码。 | ebs.params.diskName | |
| error | String | 业务细分码，为Product.Module.Code三段式大驼峰码. 请参考错误码。 | Ebs.Params.DiskName | |
| errorDetail | Object | 错误明细。一般情况下，会对订单侧(bss)的云硬盘订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。 其他订单侧(bss)的错误，以Ebs.Order.ProcFailed的errorCode统一映射返回，并在errorDetail中返回订单侧的详细错误信息。 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态。参考错误码。 | 16702126a9b211ed94aa0242ac110005 | |
| masterOrderNO | String | 订单号。 | 202235457278457684 | |
| masterResourceID | String | 主资源ID。 | a51826820e5sdkfjskdkjl442 | |
| masterResourceStatus | String | 主资源状态。只有主订单资源会返回。 | started | |
| regionID | String | 资源所属资源池ID。 | 81f7728662dd11ec810800155d307d5b | |
| resources | Array of Objects | 资源明细列表，参考表resources。 | resources |
表 resources
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskID | String | 资源底层ID，即云硬盘ID。 | 0ae97ef5-6ee2-44af-9d05-1a509b0a1be6 | |
| orderID | String | 订单ID。 | 7ce378d78ff84b47b1eef7ff392ff021 | |
| startTime | Long | 启动时刻，epoch时戳，毫秒精度。 | 1676081818000 | |
| createTime | Long | 创建时刻，epoch时戳，毫秒精度。 | 1676081818000 | |
| updateTime | Long | 更新时刻，epoch时戳，毫秒精度。 | 1676081818000 | |
| status | Integer | 资源状态。 | 2 | |
| isMaster | Boolean | 是否是主资源项。 | true | |
| itemValue | Integer | 资源规格，即为磁盘大小，单位为GB。 | 10 | |
| resourceType | String | 资源类型，云硬盘为EBS。 | EBS | |
| diskName | String | 云硬盘名称。 | ebs-newspec-test0211v7 | |
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态。 | 16702126a9b211ed94aa0242ac110005 | |
| masterResourceID | String | 主资源ID。 | a51826820e0b449c8fea9285ee7f4224 |
表 errorDetail
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| bssErrCode | String | bss错误明细码，包含于bss格式化JSON错误信息中。 | bss.xxx.xxx | |
| bssErrMsg | String | bss错误信息，包含于bss格式化JSON错误信息中。 | 账号验证失败。 | |
| bssOrigErr | String | 无法明确解码bss错误信息时，原样透出的bss错误信息。 | get account info failed | |
| bssErrPrefixHint | String | bss格式化JSON错误信息的前置提示信息。 | get account info failed |
请求示例
请求头header
{
}请求体body
{
"clientToken":"20230211ebsspec7",
"diskName":"ebs-newspec-test0211v7",
"diskMode":"VBD",
"diskType":"SATA",
"diskSize":10,
"regionID":"81f7728662dd11ec810800155d307d5b",
"azName":"az2",
"onDemand":false,
"cycleType":"month",
"cycleCount":1,
"labels":[
{
"key":"key1",
"value":"val1"
},
{
"key":"key2",
"value":"val2"
}
]
}响应示例
{
"returnObj":{
"masterResourceStatus":"started",
"regionID":"81f7728662dd11ec810800155d307d5b",
"masterOrderID":"16702126a9b211ed94aa0242ac110005",
"masterResourceID":"a51826820e0b449c8fea9285ee7f4224",
"masterOrderNO":null,
"resources":[
{
"orderID":"7ce378d78ff84b47b1eef7ff392ff021",
"status":2,
"isMaster":true,
"diskName":"ebs-newspec-test0211v7",
"resourceType":"EBS",
"masterOrderID":"16702126a9b211ed94aa0242ac110005",
"updateTime":1676081822000,
"masterResourceID":"a51826820e0b449c8fea9285ee7f4224",
"itemValue":10,
"startTime":1676081818000,
"createTime":1676081789000,
"diskID":"0ae97ef5-6ee2-44af-9d05-1a509b0a1be6"
}
]
},
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}状态码
请参考状态码
错误码
请参考错误码
