更新云硬盘
功能介绍
更新云硬盘。
URI
- URI格式
- 参数说明
参数
是否必选
描述
project_id
是
项目ID。
获取方法请参见获取项目ID。
volume_id
是
云硬盘ID。
请求消息
- 请求参数
参数
参数类型
是否必选
描述
volume
Object
是
待更新的云硬盘信息，请参见•volume参数说明。
- volume参数说明
参数
参数类型
是否必选
描述
name
String
否
云硬盘名称。最大支持255个字节。
description
String
否
云硬盘描述。最大支持255个字节。
metadata
Object
否
云硬盘的元数据。
元数据中的key和value长度不大于255字节。
display_name
String
否
同name，name和display_name任意指定一个即可（若两个都指定，则以name为主）。最大支持255个字节。
display_description
String
否
同description，description和display_description任意指定一个即可（若两个都指定，则以description为主）。最大支持255个字节。
- 请求样例
{ "volume": { "name": "test_volume", "description": "test" } }
响应消息
- 响应参数
名称
参数类型
描述
volume
Object
更新后的云硬盘信息，请参见•volumes参数说明。
error
Object
出现错误时，返回的错误信息，具体请参见•error参数说明。
- volumes参数说明
名称
参数类型
描述
id
String
云硬盘ID。
links
list<map<String,String>>
云硬盘URI自描述信息，请参见•links参数说明。
name
String
云硬盘名称。
status
String
云硬盘状态，具体请参见云硬盘状态。
attachments
list
挂载信息，请参见•attachments参数说明。
availability_zone
String
云硬盘所属AZ。
bootable
String
是否为启动云硬盘。- true：表示为启动云硬盘。
- false：表示为非启动云硬盘。
encrypted
Boolean
当前云硬盘服务不支持该字段。
created_at
String
创建云硬盘的时间。
时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
description
String
云硬盘描述。
volume_type
String
云硬盘类型。
目前支持“SATA”和“SSD”。- “SSD”为超高IO云硬盘
- “SATA”为普通IO云硬盘
replication_status
String
预留属性。
consistencygroup_id
String
预留属性。
source_volid
String
源云硬盘ID。
当前云硬盘服务不支持该字段。
snapshot_id
String
快照ID。
metadata
Object
元数据，请参见•metadata参数说明。
size
Integer
云硬盘大小，单位为GB。
user_id
String
预留属性。
updated_at
String
云硬盘更新时间。
时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
shareable
Boolean
是否为共享云硬盘。
说明：该字段已经废弃，请使用multiattach。
multiattach
Boolean
是否为共享云硬盘。- true：表示为共享云硬盘。
- false：表示为非共享云硬盘。
storage_cluster_id
String
预留属性。
- links参数说明
参数
参数类型
描述
href
String
对应的快捷链接。
rel
String
快捷链接标记名称。
- attachments参数说明
参数
参数类型
描述
server_id
String
云硬盘挂载到的云服务器的ID。
attachment_id
String
挂载信息对应的ID。
attached_at
String
挂载的时间信息。
时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
host_name
String
云硬盘挂载到的云服务器对应的物理主机的名称。
volume_id
String
云硬盘ID。
device
String
挂载点。
id
String
挂载的资源ID。
- metadata参数说明
参数
参数类型
描述
__system__encrypted
String
metadata中的表示加密功能的字段。- 0代表不加密。
- 1代表加密。
- 该字段不存在时，云硬盘默认为不加密。
__system__cmkid
String
metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。
hw:passthrough
String
metadata中的表示云硬盘设备类型的字段。- true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。
- false表示云硬盘的设备类型为VBD类型，即为默认类型，VBD只能支持简单的SCSI读写命令。
- 该字段不存在时，云硬盘默认为VBD类型。
full_clone
String
从快照创建云硬盘时，字段的值为0表示使用link克隆方式。
- error参数说明
参数
参数类型
描述
message
String
出现错误时，返回的错误消息。
code
String
出现错误时，返回的错误码。
错误码和其对应的含义请参考错误码。
- 响应样例
{ "volume": { "attachments": [ ], "availability_zone": "az-dc-1", "bootable": "false", "consistencygroup_id": null, "created_at": "2016-05-25T02:38:40.392463", "description": "create for api test", "encrypted": false, "id": "8dd7c486-8e9f-49fe-bceb-26aa7e312b66", "links": [ { "href": "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66", "rel": "self" }, { "href": "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66", "rel": "bookmark" } ], "metadata": { "volume_owner": "openapi" }, "name": "openapi_vol01", "replication_status": "disabled", "multiattach": false, "size": 40, "snapshot_id": null, "source_volid": null, "status": "creating", "updated_at": null, "user_id": "39f6696ae23740708d0f358a253c2637", "volume_type": "SAS" } }或
{ "error": { "message": "XXXX", "code": "XXX" } }其中error是泛指的错误，有badRequest、itemNotFound等，如报错为：
{ "badRequest": { "message": "XXXX", "code": "XXX" } }
错误码
请参考错误码。
