接口介绍
支持按需/包年包月创建云硬盘。
接口约束
1、用户云硬盘配额未满；
2、用户账户余额充足，该接口无法使用优惠券支付，若余额不足会创建一个待支付订单；
3、支持的线上资源池：一类节点均支持；
URI
POST JSON /v4/ebs/new
请求参数
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | 参考请求示例 | |
| regionID | 是 | String | 资源池ID, 例:100054c0416811e9a6690242ac110002 | 参考请求示例 | |
| multiAttach | 否 | Boolean | 是否多云主机挂载，默认false | 参考请求示例 | |
| isEncrypt | 否 | Boolean | 是否加密盘，默认false | 参考请求示例 | |
| kmsUUID | 否 | String | 如果是加密盘，需要提供kms的uuid | 参考请求示例 | |
| projectID | 否 | String | 企业项目ID,默认为”0” | 参考请求示例 | |
| diskMode | 是 | String | 磁盘模式，VBD/ISCSI/FCSAN | 参考请求示例 | |
| diskType | 是 | String | 磁盘类型，SATA/SAS/SSD-genric/SSD/FAST-SSD 磁盘类型详情：SATA：普通IO，SAS：高IO，SSD-genric：通用型SSD，SSD：超高IO，FAST-SSD：极速型SSD |
参考请求示例 | |
| name | 是 | String | 磁盘命名，单账户单资源池下，命名需唯一 | 参考请求示例 | |
| diskSize | 是 | Integer | 磁盘大小，单位GB | 参考请求示例 | |
| onDemand | 否 | Boolean | 是否按需下单。默认为true | 参考请求示例 | |
| cycleType | 否 | String | 包周期类型，year/month。onDemand为false时，必须指定。 | 参考请求示例 | |
| cycleCount | 否 | Integer | 包周期数。onDemand为false时必须指定。周期最大长度不能超过5年 | 参考请求示例 | |
| azName | 否 | String | 多可用区资源池下，必须指定可用区 | 参考请求示例 | |
| imageID | 否 | String | 镜像ID，如果用镜像创建，只支持数据盘的私有镜像，所创建的数据盘的所在地域要与镜像源一致，容量不可小于镜像对应的磁盘容量，不支持批量创建操作，从镜像创建的数据盘不支持加密、iSCSI和FCSAN高级配置 | 参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800为成功，900为处理中/失败) | ||
| message | 是 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 是 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 是 | Object | 参考表returnObj | 参考表returnObj | |
| errorCode | 是 | String | 业务细分码，为product.module.code三段式码. 参考通用结果码 |
||
| errorDetail | 是 | Object | 错误明细。一般情况下，会对订单侧(bss)的云硬盘订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。 其他订单侧(bss)的错误，以ebs.order.procFailed的errorCode统一映射返回，并在errorDetail中返回订单侧的详细错误信息 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterOrderID | 是 | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态 参考[结果码] |
||
| masterOrderNO | 是 | String | 订单号 | ||
| masterResourceID | 是 | String | 主资源ID。云硬盘场景下，无需关心 | ||
| masterResourceStatus | 是 | String | 主资源状态。只有主订单资源会返回。unknown/failed/ starting，具体状态信息请参考资源状态 | ||
| regionID | 是 | String | 资源所属资源池ID | ||
| resources | 是 | Object | 资源明细列表,参考表resources | 参考表resources |
表 resources
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| resourceID | 是 | String | 单项资源的变配、续订、退订等需要该资源项的ID。 比如某个云主机资源作为主资源，对其挂载 |
磁盘操作时，需要磁盘资源项的资源ID | |
| orderID | 是 | String | 无需关心 | ||
| startTime | 是 | Integer | 启动时刻，epoch时戳，毫秒精度 | ||
| createTime | 是 | Integer | 创建时刻，epoch时戳，毫秒精度 | ||
| updateTime | 是 | Integer | 更新时刻，epoch时戳，毫秒精度 | ||
| status | 是 | Integer | 资源状态，无需关心。参考masterResourceStatus | ||
| isMaster | 是 | Boolean | 是否是主资源项 | ||
| itemValue | 是 | Integer | 资源规格，磁盘资源为磁盘大小GB | ||
| resourceUUID | 是 | String | 资源UUID，结合regionID一起使用 | ||
| resourceType | 是 | String | 资源类型，云硬盘为EBS | ||
| masterResourceID | 是 | String | 主资源ID。云硬盘场景下，无需关心 | ||
| resourceConfig | 是 | Object of String | 可忽略 | ||
| name | 是 | String | 云硬盘名称 |
表 errorDetail
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| bssErrCode | 是 | String | bss错误明细码，包含于bss格式化JSON错误信息中 | ||
| bssErrMsg | 是 | String | bss错误信息，包含于bss格式化JSON错误信息中 | ||
| bssOrigErr | 是 | String | 无法明确解码bss错误信息时，原样透出的bss错误信息 | ||
| bssErrPrefixHint | 是 | String | bss格式化JSON错误信息的前置提示信息 |
请求示例
请求头header
{
}
请求体body
{
"clientToken": "",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"multiAttach": false,
"isEncrypt": false,
"kmsUUID": "",
"projectID": "0",
"diskMode": "VBD/ISCSI/FCSAN",
"diskType": "SATA/SAS/SSD-genric/SSD",
"name": "mydisk-0001",
"diskSize": 200,
"onDemand": false,
"cycleType": "month",
"cycleCount": 2,
"azName": "az1"
}
响应示例
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"masterOrderID": "beacf51a20dd4889bfc99877d89e03e2",
"masterResourceID": "2ec9776a9ad94343b4ece701ce18e688",
"masterOrderNO": "20220812171600203284",
"resources": [
{
"orderID": "a71317c1efee48c2b44de52eb9a2d4a7",
"status": 2,
"isMaster": true,
"resourceType": "EBS",
"resourceID": "2ec9776a9ad94343b4ece701ce18e688",
"masterOrderID": "beacf51a20dd4889bfc99877d89e03e2",
"updateTime": 1660295799000,
"masterResourceID": "2ec9776a9ad94343b4ece701ce18e688",
"itemValue": "10",
"startTime": 1660295799000,
"resourceUUID": "770fb5e7-7f84-423c-9dd4-2eaf7912d5bc",
"createTime": 1660295761000
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
错误码
请参考通用结果码。
