接口约束
6.1.4 更新云硬盘
功能介绍
更新一个云硬盘的名称和描述。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v2/{project_id}/cloudvolumes/{volume_id}
表6-25 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。 获取方法请参见"获取
项目ID"。
volume_id 是 String 云硬盘ID。
请求参数
表6-26 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。 通过调用IAM服务 获取用户Token接口获取（响应 消息头中X-Subject-Token的 值）。
表6-27 请求 Body 参数
参数 是否必选 参数类型 描述
volume 是 UpdateVolu meOption object
待修改的云硬盘信息
表6-28 UpdateVolumeOption
参数 是否必选 参数类型 描述
description 否 String 新的云硬盘的描述，name和 description不能同时为null。最 大支持255个字节。
name 否 String 新的云硬盘的名字，name和
description不能同时为null。最 大支持255个字节。
响应参数
状态码： 200
表6-29 响应 Body 参数
参数 参数类型 描述
attachments Array of Attachment objects
是否挂载信息。
availability_zo
ne String 云硬盘所属AZ。
bootable String 是否为可启动云硬盘。
created_at String 创建云硬盘的时间。
id String 云硬盘ID。
links Array of Link
objects 云硬盘uri自描述信息 metadata VolumeMeta
data object 云硬盘的元数据。
multiattach Boolean 是否为可共享云硬盘。
name String 云硬盘名称
os-vol-host-attr:host String 预留属性。
参数 参数类型 描述
os-vol-tenant-attr:tenant_id String 云硬盘所属的项目ID。
shareable String 是否为共享云硬盘。
size Integer 云硬盘大小。
snapshot_id String 快照ID。
source_volid String 预留字段。
status String 云硬盘状态。
volume_imag
e_metadata Object 云硬盘镜像的元数据。
说明关于“volume_image_metadata”字段的详细说明，
具体请参见："查询镜像详情"。
volume_type String 云硬盘类型。
description String 云硬盘描述。
os-volume-replication:ext ended_status
String 预留属性。
表6-30 Attachment
参数 参数类型 描述
attached_at String 挂载的时间信息。
时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX attachment_i
d String 挂载信息对应的ID。
device String 挂载点。
host_name String 云硬盘挂载到的云服务器对应的物理主机的名 称。
id String 挂载的资源ID。
server_id String 云硬盘挂载到的云服务器的 ID。
volume_id String 云硬盘ID。
表6-31 Link
参数 参数类型 描述
href String 对应的快捷链接。
rel String 快捷链接标记名称。
表6-32 VolumeMetadata
参数 参数类型 描述
__system__cm
kid String metadata中的加密cmkid字段，与
__system__encrypted配合表示需要加密，cmkid 长度固定为36个字节。
说明请求获取密钥ID的方法请参考："查询密钥列表"。
__system__en
crypted String metadata中的表示加密功能的字段，0代表不加 密，1代表加密。 不指定该字段时，云硬盘的加 密属性与数据源保持一致，如果不是从数据源创 建的场景，则默认不加密。
full_clone String 从快照创建云硬盘时的创建方式。
● 0表示使用链接克隆方式。
● 1表示使用全量克隆方式。
hw:passthrou
gh String ● true表示云硬盘的设备类型为SCSI类型，即允 许ECS操作系统直接访问底层存储介质。支持 SCSI锁命令。
● false表示云硬盘的设备类型为VBD (虚拟块存 储设备 , Virtual Block Device)类型，即为默 认类型，VBD只能支持简单的SCSI读写命令。
● 该字段不存在时，云硬盘默认为VBD类型。
orderID String metadata中的表示云硬盘计费类型的字段。 当 该字段有值时，表示该云硬盘的计费类型为包周 期计费，否则计费类型为按需计费。
状态码： 400
表6-33 响应 Body 参数
参数 参数类型 描述
error Error object 出现错误时，返回的错误信息
表6-34 Error
参数 参数类型 描述
code String 出现错误时，返回的错误码。 错误码和其对应的 含义请参考错误码说明。
message String 错误提示信息。
请求示例
PUT https://{endpoint}/v2/{project_id}/cloudvolumes/{volume_id}
{ "volume" : {
"name" : "test_volume", "description" : "test"
}}
响应示例
状态码： 200 OK
{ "id" : "36ba39af-3579-4e6e-adfc-b764349c0f77", "links" : [ {
"href" : "https://volume.region.xxx.xxx-tsi.de/v2/3cfb09080bd944d0b4cdd72ef26857bd/volumes/
36ba39af-3579-4e6e-adfc-b764349c0f77", "rel" : "self"
}, {
"href" : "https://volume.region.xxx.xxx-tsi.de/3cfb09080bd944d0b4cdd72ef26857bd/volumes/
36ba39af-3579-4e6e-adfc-b764349c0f77", "rel" : "bookmark"
} ],
"name" : "newVolume", "status" : "in-use", "attachments" : [ {
"server_id" : "c3d3250c-7ce5-42cc-b620-dd2b63d19ca5", "attachment_id" : "011a2bdb-a033-4479-845b-50bd8ed7f4d4", "attached_at" : "2017-05-23T11:27:38.604815",
"host_name" : null,
"volume_id" : "36ba39af-3579-4e6e-adfc-b764349c0f77", "device" : "/dev/sdf",
"id" : "36ba39af-3579-4e6e-adfc-b764349c0f77"
} ],
"description" : "new volume", "multiattach" : false, "shareable" : false, "size" : 10, "metadata" : {
"policy" : "dc71a9c9-b3fa-429d-a070-037682d82d21", "attached_mode" : "rw",
"readonly" : "False", "hw:passthrough" : "false"
}, "bootable" : "false",
"availability_zone" : "az-dc-1", "os-vol-host-attr:host" : null, "source_volid" : null,
"volume_type" : "SATA",
"os-vol-tenant-attr:tenant_id" : null, "volume_image_metadata" : null }
状态码： 400 Bad Request
{ "error" : {
"message" : "XXXX", "code" : "XXX"
}}
状态码
状态码 描述
200 OK
400 Bad Request
错误码
请参见错误码。