创建云硬盘(废弃)
功能介绍
创建一个或多个云硬盘。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/cloudvolumes
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用 |
X-Client-Token |
否 |
String |
请求的幂等标识。该参数的值由客户端生成，需要确保不同请求的参数值唯一，取值为36位的UUID格式字符串，有效期为8小时。携带相同幂等标识的多个请求，会认为多个请求为同一个幂等请求，会返回相同的响应体。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
volume |
是 |
CreateVolumeOptionV3 object |
待创建的云硬盘。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
backup_id |
否 |
String |
备份ID，从备份创建云硬盘时为必选。
说明：
获取备份ID的方法：请参见查询所有备份。 |
availability_zone |
是 |
String |
指定要创建云硬盘的所属AZ，若指定的AZ不存在，则创建云硬盘失败。
说明：
获取AZ的方法：请参考查询所有的可用分区信息获取。 |
description |
否 |
String |
云硬盘的描述。最大支持85个字符。 |
size |
否 |
Integer |
云硬盘大小，单位为GiB，其限制如下： 系统盘：1GiB-1024GiB 数据盘：10GiB-32768GiB 创建空白云硬盘，size为必选，请在范围内根据需求自定义。 从快照创建云硬盘时，size为必选，且云硬盘大小不能小于快照大小。 从镜像创建云硬盘时，size为必选，且云硬盘大小不小于镜像属性中min_disk要求的最小云硬盘容量。 从备份创建云硬盘时，size为可选，不指定size时，云硬盘大小和备份大小一致。
说明：
如果发送请求时，将参数值设置为小数，则默认取小数点前的整数。 |
name |
否 |
String |
云硬盘名称。如果为创建单个云硬盘，name为云硬盘名称。最大支持85个字符。创建的云硬盘数量（count字段对应的值）大于1时，为区分不同云硬盘，创建过程中系统会自动在名称后加“-0000”的类似标记。例如：volume-0001、volume-0002。 |
snapshot_id |
否 |
String |
快照ID，指定该参数表示创建云硬盘方式为从快照创建云硬盘。
说明：
获取快照ID的方法：请参见 查询云硬盘快照详细信息列表。 |
imageRef |
否 |
String |
IMS中镜像ID，指定该参数表示创建云硬盘方式为从镜像创建云硬盘。
说明：
不支持通过BMS的镜像创建BMS系统盘。 获取镜像ID的方法：请参见查询镜像列表。 |
volume_type |
是 |
String |
云硬盘类型。目前支持"SATA"，"SAS"，"GPSSD"和"SSD"四种。
说明：
从快照创建云硬盘时，volume_type字段必须和快照源云硬盘保持一致。 了解不同云硬盘类型的详细信息，请参见 云硬盘类型及性能介绍。 |
count |
否 |
Integer |
批量创云硬盘的个数。如果无该参数，表明只创建1个云硬盘，目前最多支持批量创建100个。 从备份创建云硬盘时，不支持批量创建，数量只能为“1”。
说明：
如果发送请求时，将参数值设置为小数，则默认取小数点前的整数。 |
shareable |
否 |
String |
是否为共享云硬盘。true为共享盘，false为普通云硬盘。
说明：
该字段已经废弃，请使用multiattach。 |
metadata |
否 |
VolumeMetadataV3 object |
待创建的云硬盘信息 |
multiattach |
否 |
String |
创建共享云硬盘的信息。默认值为false。true：表示为共享云硬盘。false：表示为非共享云硬盘。 请参见共享云硬盘及使用方法了解更多信息。 |
tags |
否 |
Map<String,String> |
创建云硬盘的时候，给云硬盘绑定标签。 单个云硬盘最多可以创建10个标签。 标签的key需要唯一。重复的key会做去重操作，即如果有重复的key，最终只保留一个作为有效的标签。 标签的key：String类型，最大长度36个字符。 由英文字母、数字、下划线、中划线、UNICODE字符（\u4E00-\u9FFF）组成。 标签的value：String类型，最大长度43个字符，可以为空字符串。 由英文字母、数字、下划线、点、中划线、UNICODE字符（\u4E00-\u9FFF）组成。 |
enterprise_project_id |
否 |
String |
企业项目ID。 创建云硬盘时，给云硬盘绑定企业项目ID。该参数不传，或者将该参数值设置为0，则将资源绑定给默认企业项目。 关于企业项目ID的获取及企业项目特性的详细信息，请参见企业管理用户指南。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
__system__cmkid |
否 |
String |
metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。 |
__system__encrypted |
否 |
String |
metadata中的表示加密功能的字段。 0代表不加密。 1代表加密。 该字段不存在时，云硬盘默认为不加密。 |
full_clone |
否 |
String |
从快照创建云硬盘时的创建方式。
|
hw:passthrough |
否 |
String |
metadata中的表示云硬盘设备类型的字段。 true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 该字段不存在时，云硬盘默认为VBD类型。 |
orderID |
否 |
String |
metadata中的表示云硬盘计费类型的字段。 当该字段有值时，表示该云硬盘的计费类型为包周期计费，否则计费类型为按需计费。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
job_id |
String |
正常返回时返回的任务ID。
说明：
如果需要查询job的状态，请参考查询job的状态。 |
请求示例
POST https://{endpoint}/v3/{project_id}/cloudvolumes
{
"volume" : {
"count" : 1,
"availability_zone" : "az-dc-1",
"description" : "test_volume_1",
"size" : 120,
"name" : "test_volume_1",
"volume_type" : "SSD",
"metadata" : {
"__system__encrypted" : "1",
"__system__cmkid" : "37b0d52e-c249-40d6-83cb-2b93f22445bd"
}
}
}
响应示例
无
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
错误码
请参见错误码。
