接口功能介绍
该接口提供用户轻量型云主机新建云硬盘的能力
1. 云硬盘购买完成后自动挂载至轻量型云主机
2. 数据盘到期日与所挂载的实例一致
3. 实例和数据盘必须一起续费，无法单独为实例或数据盘续费
4. 若数据盘所属轻量型云主机已开启自动续费，则数据盘默认开启自动续费
5. 云硬盘计费方式：包年包月
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
计费模式：确认开通云主机的计费模式及计费项，详细查看计费方式及计费项
产品选型：购买轻量型云主机前，请先阅读实例套餐了解轻量型云主机的规格套餐，并通过查询轻量型云主机的规格套餐资源接口，获取当前资源池可用轻量型云主机规格信息
注意事项：
成本估算：了解云主机的计费项，详细查看价格总览进行成本估算
用户配额：确认个人在不同资源池下资源配额，可以通过用户配额查询接口进行查询
异步接口：该接口为异步接口，下单成功不代表业务成功。
接口约束
1. 确保当前请求资源池下，该轻量型云主机存在（即instanceID真实存在且与regionID相对应）
2. 云主机需要处于运行中（running）或关机（stopped）状态，您可以调用查询轻量型云主机详情查询结果中的instanceStatus字段来确认当前云主机状态
URI
POST /v4/ecs/lite/create-volume
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，使用同一个ClientToken值，其他请求参数相同时，则代表为同一个请求。保留时间为24小时 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| instanceID | 是 | String | 轻量型云主机ID，您可以查看轻量型云主机了解轻量型云主机的相关信息 获取： 查 查询轻量型云主机列表 创 创建轻量型云主机 |
adc614e0-e838-d73f-0618-a6d51d09070a | |
| diskName | 是 | String | 磁盘名称，名称规则：长度2~63，不支持中文。注：当创建多块云硬盘时（即参数diskCount的值大于1时），第二块盘起名称会追加序号。 | vol-test | |
| diskType | 是 | String | 磁盘类型，取值范围： SATA（普通IO）， SAS（高IO）， SSD（超高IO）， SSD-genric（通用型SSD） 您可以查看磁盘类型及性能介绍磁盘类型相关信息 |
||
| diskSize | 是 | Integer | 磁盘容量，单位为GB，取值范围：[10, 32768] | 20 | |
| diskCount | 否 | Integer | 本地订购磁盘数量。注：不填写默认为1块盘，创建多块盘时填写多个；该参数值受单台轻量型云主机挂载硬盘上限值限制。 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态 | 235145e4489811eda8330242ac110002 | |
| masterOrderNO | String | 订单号 | 20221010142913884246 | |
| masterResourceID | String | 主资源ID | 3cda4bf48cac42b8b7db3b279d2fc6fb | |
| regionID | String | 资源所属资源池ID | aaf589124d5d11eaa04d0242ac110002 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"clientToken": "lite-ecs-create-vol-test01",
"instanceID": "adc614e0-e838-d73f-0618-a6d51d09070a",
"diskType": "SATA",
"diskSize": 10,
"diskName": "att-test",
"diskCount": 2
}
响应示例
{
"returnObj": {
"regionID": "aaf589124d5d11eaa04d0242ac110002",
"masterOrderID": "107e901c449611ed8b6a0242ac110002",
"masterOrderNO": "20221009163836430197"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
