功能介紹
更新一個 云硬盤 的名稱和描述。
調試
您可以在API Explorer中調試該接口，支持自動認證鑒權。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調試功能。
URI
PUT /v2/{project_id}/cloudvolumes/{volume_id}
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目ID。獲取方法請參見"獲取項目ID"。 |
|
volume_id |
是 |
String |
云硬盤ID。 |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過調用 IAM 服務獲取用戶Token接口獲?。憫㈩^中X-Subject-Token的值）。 |
響應參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
attachments |
是否掛載信息。 |
|
|
availability_zone |
String |
云硬盤所屬AZ。 |
|
bootable |
String |
是否為可啟動云硬盤。 |
|
created_at |
String |
創(chuàng)建云硬盤的時間。 |
|
id |
String |
云硬盤ID。 |
|
links |
云硬盤uri自描述信息 |
|
|
metadata |
云硬盤的元數(shù)據。 |
|
|
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 |
云硬盤狀態(tài)。 |
|
volume_image_metadata |
Object |
云硬盤 鏡像 的元數(shù)據。> > > 關于“volume_image_metadata”字段的詳細說明，具體請參見："查詢鏡像詳情"。 |
|
volume_type |
String |
云硬盤類型。 |
|
description |
String |
云硬盤描述。 |
|
os-volume-replication:extended_status |
String |
預留屬性。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
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。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
__system__cmkid |
String |
metadata中的加密cmkid字段，與__system__encrypted配合表示需要加密，cmkid長度固定為36個字節(jié)。> > 請求獲取密鑰ID的方法請參考："查詢密鑰列表"。 |
|
__system__encrypted |
String |
metadata中的表示加密功能的字段，0代表不加密，1代表加密。 不指定該字段時，云硬盤的加密屬性與數(shù)據源保持一致，如果不是從數(shù)據源創(chuàng)建的場景，則默認不加密。 |
|
full_clone |
String |
從快照創(chuàng)建云硬盤時的創(chuàng)建方式。
|
|
hw:passthrough |
String |
|
|
orderID |
String |
metadata中的表示云硬盤計費類型的字段。 當該字段有值時，表示該云硬盤的計費類型為包周期計費，否則計費類型為按需計費。 |
狀態(tài)碼： 400
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
error |
出現(xiàn)錯誤時，返回的錯誤信息，具體請參見 error參數(shù)說明。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
code |
String |
出現(xiàn)錯誤時，返回的錯誤碼。錯誤碼和其對應的含義請參考錯誤碼說明。 |
|
message |
String |
出現(xiàn)錯誤時，返回的錯誤消息。 |
請求示例
更新云硬盤的名稱和描述。
PUT https://{endpoint}/v2/{project_id}/cloudvolumes/{volume_id}
{
"volume" : {
"name" : "test_volume",
"description" : "test"
}
}
響應示例
狀態(tài)碼： 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"
}
狀態(tài)碼： 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
錯誤碼
請參見錯誤碼。
