创建云硬盘(废弃)
功能介绍
创建一个或多个云硬盘。由于兼容性原因导致存在该接口,目前已经废弃。请使用性能更佳的接口。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/{project_id}/cloudvolumes
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目 ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
volume |
是 |
CreateDiskOption object |
待创建的云硬盘信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
availability_zone |
是 |
String |
指定要创建云硬盘的可用区。 |
backup_id |
否 |
String |
备份ID,从备份创建云硬盘时为必选。 |
count |
否 |
Integer |
批量创云硬盘的个数。如果无该参数,表明只创建1个云硬盘,目前最多支持批量创建100个。 从备份创建云硬盘时,不支持批量创建,数量只能为“1”。 如果发送请求时,将参数值设置为小数,则默认取小数点前的整数。 |
description |
否 |
String |
云硬盘的描述。最大支持255个字节。 |
enterprise_project_id |
否 |
String |
企业项目ID。创建云硬盘时,给云硬盘绑定企业项目ID。 |
imageRef |
否 |
String |
镜像ID,指定该参数表示创建云硬盘方式为从镜像创建云硬盘。 |
metadata |
否 |
Map<String,String> |
创建云硬盘的metadata信息可选参数如下:metadata中的加密cmkid字段,与__system__encrypted配合表示需要加密,cmkid长度固定为36个字节。 说明:
请求获取密钥ID的方法请参考:"查询密钥列表"。 __system__encrypted: metadata中的表示加密功能的字段,0代表不加密,1代表加密。不指定该字段时,云硬盘的加密属性与数据源保持一致,如果不是从数据源创建的场景,则默认不加密。 full_clone: 从快照创建云硬盘时,如需使用link克隆方式,请指定该字段的值为0。 hw:passthrough:
|
multiattach |
否 |
Boolean |
是否为共享云硬盘。true为共享盘,false为普通云硬盘。 |
name |
否 |
String |
云硬盘名称。 如果为创建单个云硬盘,name为云硬盘名称。最大支持255个字节。 创建的云硬盘数量(count字段对应的值)大于1时,为区分不同云硬盘,创建过程中系统会自动在名称后加“-0000”的类似标记。例如:volume-0001、volume-0002。最大支持250个字节。 |
shareable |
否 |
String |
是否为共享云硬盘。true为共享盘,false为普通云硬盘。 该字段已经废弃,请使用multiattach。 |
size |
是 |
Integer |
云硬盘大小,单位为GB,其限制如下: 系统盘:1GB-1024GB 数据盘:10GB-32768GB 创建空白云硬盘和从 镜像/快照 创建云硬盘时,size为必选,且云硬盘大小不能小于 镜像/快照 大小。 从备份创建云硬盘时,size为可选,不指定size时,云硬盘大小和备份大小一致。 |
snapshot_id |
否 |
String |
快照ID,指定该参数表示创建云硬盘方式为从快照创建云硬盘。 |
volume_type |
是 |
String |
云硬盘类型。 目前支持"SATA","SAS","GPSSD"和"SSD"四种。
当指定的云硬盘类型在avaliability_zone内不存在时,则创建云硬盘失败。 说明:
说明: 从快照创建云硬盘时,volume_type字段必须和快照源云硬盘保持一致。 了解不同磁盘类型的详细信息,请参见 磁盘类型及性能介绍。 枚举值:
|
tags |
否 |
Map<String,String> |
云硬盘标签信息。 |
响应参数
状态码: 202
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
正常返回时返回的任务ID。 说明:
如果需要查询job的状态,请参考查询job的状态。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
Error object |
出现错误时,返回的错误信息 |
请求示例
{ "volume" : { "backup_id" : null, "count" : 1, "availability_zone" : "az1.dc1", "description" : "test_volume_1", "size" : 120, "name" : "test_volume_1", "imageRef" : null, "volume_type" : "SSD", "metadata" : { "__system__encrypted" : "0", "__system__cmkid" : null } } }
响应示例
状态码: 202
Accepted
{ "job_id" : "70a599e0-31e7-49b7-b260-868f441e862b" }
状态码: 400
Bad Request
{ "error" : { "message" : "XXXX", "code" : "XXX" } }
状态码
状态码 |
描述 |
---|---|
202 |
Accepted |
400 |
Bad Request |
错误码
请参见错误码。
