创建云硬盘v3
更新时间 2025-12-25 09:46:41
最近更新时间: 2025-12-25 09:46:41
接口功能介绍
- 云硬盘功能请联系客户经理开通。
接口约束
无
URI
POST /v3/cloudVolume/create
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| billMode | 否 | String | 订购类型。取值范围: - Cycle:包周期。 - OnDemand:按需。 - ResBag:资源包。 | ||
| cycleType | 否 | String | 周期类型(仅创建单独付费云电脑有效)。取值范围: - Month:按月。(仅订购类型为包周期类型有效) | ||
| cycleCnt | 否 | Integer | 周期数(仅创建单独付费云电脑有效)。取值范围: - 1-36。(仅订购类型为包周期类型有效) | ||
| autoPay | 否 | Boolean | 是否自动支付(仅创建单独付费云电脑有效),默认false。取值范围: - true:是。(仅订购类型为包周期类型有效,需账号有足够金额) - false:否。(仅订购类型为包周期类型有效) | ||
| volumeName | 是 | String | 云硬盘名称 | ||
| diskType | 是 | String | 云硬盘类型(uhio-超高IO;hio-高IO;cio-普通IO) | ||
| count | 是 | Integer | 数量,范围:[1, 50] | ||
| volumeSize | 是 | Integer | 云硬盘大小(单位:GB),大于等于10 | ||
| encryption | 是 | Boolean | 是否加密,true表示为加密,false表示为不加密 | ||
| desktopOid | 否 | String | 云电脑ID,当使用立即挂载功能时,此字段必传,创建出来的云硬盘会立即挂载到该云电脑上 | ||
| mountPath | 否 | String | 挂载目录,当使用立即挂载功能且指定的计算增强型云电脑操作系统为Linux时,若此字段不为空,则创建出来的云硬盘会立即挂载到该云电脑的挂载目录上 | ||
| vpcOid | 是 | String | VPC ID | ||
| resourcePackOid | 是 | String | 资源包ID |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 | ||
| error | String | 错误码。 | ||
| message | String | 提示信息。 | ||
| returnObj | Object | 返回数据对象 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| submitted | Boolean | 是否提交成功(仅创建单独付费云硬盘有效)。 | ||
| errorMessage | String | 错误信息(仅创建单独付费云硬盘有效)。 | ||
| newOrderNo | String | 订单号(仅创建单独付费云硬盘有效)。 | ||
| newOrderId | String | 订单id(仅创建单独付费云硬盘有效)。 | ||
| totalPrice | String | 总价格(仅创建单独付费云硬盘有效)。 | ||
| operations | Array of Objects | 创建云硬盘操作列表。可用于查询操作状态和新建云硬盘ID(相关接口:异步操作-查询操作详情)。 | operations | |
| 表 operations |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| operationId | String | 操作ID。 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
请求头header
无
请求体body
{
"billMode":"Cycle",
"cycleType":3,
"cycleCnt":1,
"autoPay":true,
"volumeName":"cvtest",
"diskType":"uhio",
"count":1,
"volumeSize":40,
"encryption":false,
"vpcOid":"xxxxxxxxxxx",
"resourcePackOid":"xxxxxxxxxx"
}
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"operations":[{
"operationId":"job_orderabc7211cb74fbb283e4280kf87"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码