功能介绍
更新一个 云硬盘 的名称和描述。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
PUT /v2/{project_id}/cloudvolumes/{volume_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见"获取项目ID"。 |
|
volume_id |
是 |
String |
云硬盘ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
attachments |
是否挂载信息。 |
|
|
availability_zone |
String |
云硬盘所属AZ。 |
|
bootable |
String |
是否为可启动云硬盘。 |
|
created_at |
String |
创建云硬盘的时间。 |
|
id |
String |
云硬盘ID。 |
|
links |
云硬盘uri自描述信息 |
|
|
metadata |
云硬盘的元数据。 |
|
|
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_image_metadata |
Object |
云硬盘 镜像 的元数据。> > > 关于“volume_image_metadata”字段的详细说明，具体请参见："查询镜像详情"。 |
|
volume_type |
String |
云硬盘类型。 |
|
description |
String |
云硬盘描述。 |
|
os-volume-replication:extended_status |
String |
预留属性。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
attached_at |
String |
挂载的时间信息。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
|
attachment_id |
String |
挂载信息对应的ID。 |
|
device |
String |
挂载点。 |
|
host_name |
String |
云硬盘挂载到的 云服务器 对应的物理主机的名称。 |
|
id |
String |
挂载的资源ID。 |
|
server_id |
String |
云硬盘挂载到的 云服务 器的 ID。 |
|
volume_id |
String |
云硬盘ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
__system__cmkid |
String |
metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。> > 请求获取密钥ID的方法请参考："查询密钥列表"。 |
|
__system__encrypted |
String |
metadata中的表示加密功能的字段，0代表不加密，1代表加密。 不指定该字段时，云硬盘的加密属性与数据源保持一致，如果不是从数据源创建的场景，则默认不加密。 |
|
full_clone |
String |
从快照创建云硬盘时的创建方式。
|
|
hw:passthrough |
String |
|
|
orderID |
String |
metadata中的表示云硬盘计费类型的字段。 当该字段有值时，表示该云硬盘的计费类型为包周期计费，否则计费类型为按需计费。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
出现错误时，返回的错误信息，具体请参见 error参数说明。 |
请求示例
更新云硬盘的名称和描述。
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",
"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" : {
"hw:passthrough" : "false"
},
"bootable" : "false",
"availability_zone" : "az-dc-1",
"created_at" : "2017-05-23T09:49:44.481299",
"volume_type" : "SATA"
}
状态码： 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
错误码
请参见错误码。
