接口功能介绍
支持按需/包年包月创建云硬盘。
接口约束
1、用户云硬盘配额未满;
2、用户账户余额充足,该接口无法使用优惠券支付,若余额不足会创建一个待支付订单;
接口是否审批
否
URI
POST JSON /v4/ebs/new-ebs
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 否 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一 | 20230211ebsspec7 | |
regionID | 是 | String | 资源池ID, 例:100054c0416811e9a6690242ac110002 | 81f7728662dd11ec810800155d307d5b | |
multiAttach | 否 | Boolean | 是否多云主机挂载,默认false,XSSD类型盘不支持多挂载 | false | |
isEncrypt | 否 | Boolean | 是否加密盘,默认false,XSSD类型盘不支持加密 | false | |
kmsUUID | 否 | String | 如果是加密盘,需要提供kms的uuid | asondsnsdslddsdd | |
projectID | 否 | String | 企业项目ID,默认为”0” | 0 | |
diskMode | 是 | String | 磁盘模式,VBD/ISCSI/FCSAN,XSSD类型盘不支持ISCSI和FCSAN | VBD | |
diskType | 是 | String | 磁盘类型,SATA/SAS/SSD-genric/SSD/FAST-SSD,极速ssd类型盘(FAST-SSD)不支持iscsi、只有高io类型(SAS)支持fcsan,XSSD类型盘不支持多挂载,加密,ISCSI和FCSAN | SATA | |
diskName | 是 | String | 磁盘命名,单账户单资源池下,命名需唯一 | ebs-newspec-test0211v7 | |
diskSize | 是 | Integer | 磁盘大小,单位GB | 10 | |
onDemand | 否 | Boolean | 是否按需下单。默认为true | false | |
cycleType | 否 | String | 包周期类型,year/month。onDemand为false时,必须指定。 | month | |
cycleCount | 否 | Integer | 包周期数。onDemand为false时必须指定。周期最大长度不能超过5年 | 1 | |
azName | 否 | String | 多可用区资源池下,必须指定可用区 | az2 | |
imageID | 否 | String | 镜像ID,如果用镜像创建,只支持数据盘的私有镜像,所创建的数据盘的所在地域要与镜像源一致,容量不可小于镜像对应的磁盘容量,不支持批量创建操作,从镜像创建的数据盘不支持加密、iSCSI和FCSAN高级配置 | sjsidfnsdfsf | |
provisionedIops | 否 | Integer | XSSD类型盘的预配置iops值,最小值为1,其他类型的盘不支持设置 | 1 | |
deleteSnapWithEbs | 否 | Boolean | 设置全部快照是否随盘删除 | false | |
labels | 否 | Array of Objects | 设置云硬盘标签,实际绑定标签的结果请查询云硬盘详情的labels返回值是否如预期 | [{"key":"xxxx","value":"xxxx"}] | labels |
表 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 | 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 | 主资源状态。只有主订单资源会返回。unknown/failed/ starting,具体状态信息请参考资源状态 | started | |
regionID | String | 资源所属资源池ID | 81f7728662dd11ec810800155d307d5b | |
resources | Object | 资源明细列表,参考表resources | resources |
表 resources
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
diskID | String | 资源底层ID,即磁盘ID | 0ae97ef5-6ee2-44af-9d05-1a509b0a1be6 | |
orderID | String | 无需关心 | 7ce378d78ff84b47b1eef7ff392ff021 | |
startTime | Integer | 启动时刻,epoch时戳,毫秒精度 | 1676081818000 | |
createTime | Integer | 创建时刻,epoch时戳,毫秒精度 | 1676081818000 | |
updateTime | Integer | 更新时刻,epoch时戳,毫秒精度 | 1676081818000 | |
status | Integer | 资源状态,无需关心。参考masterResourceStatus | 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
}
状态码
请参考状态码