更新云硬盘
功能介绍
更新一个云硬盘的名称和描述。
调用方法
请参见如何调用API。
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的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
volume |
是 |
UpdateVolumeOption object |
待修改的云硬盘信息 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
attachments |
Array of Attachment objects |
是否挂载信息。 |
availability_zone |
String |
云硬盘所属AZ。 |
bootable |
String |
是否为可启动云硬盘。 |
created_at |
String |
创建云硬盘的时间。 |
id |
String |
云硬盘ID。 |
links |
Array of Link objects |
云硬盘uri自描述信息 |
metadata |
VolumeMetadata 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_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
请求示例
更新云硬盘的名称和描述。
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" } }
SDK代码示例
SDK代码示例如下。
更新云硬盘的名称和描述。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.evs.v2.region.EvsRegion; import com.huaweicloud.sdk.evs.v2.*; import com.huaweicloud.sdk.evs.v2.model.*; public class UpdateVolumeSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); EvsClient client = EvsClient.newBuilder() .withCredential(auth) .withRegion(EvsRegion.valueOf("<YOUR REGION>")) .build(); UpdateVolumeRequest request = new UpdateVolumeRequest(); UpdateVolumeRequestBody body = new UpdateVolumeRequestBody(); UpdateVolumeOption volumebody = new UpdateVolumeOption(); volumebody.withDescription("test") .withName("test_volume"); body.withVolume(volumebody); request.withBody(body); try { UpdateVolumeResponse response = client.updateVolume(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
更新云硬盘的名称和描述。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkevs.v2.region.evs_region import EvsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkevs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = EvsClient.new_builder() \ .with_credentials(credentials) \ .with_region(EvsRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateVolumeRequest() volumebody = UpdateVolumeOption( description="test", name="test_volume" ) request.body = UpdateVolumeRequestBody( volume=volumebody ) response = client.update_volume(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
更新云硬盘的名称和描述。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" evs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := evs.NewEvsClient( evs.EvsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateVolumeRequest{} descriptionVolume:= "test" nameVolume:= "test_volume" volumebody := &model.UpdateVolumeOption{ Description: &descriptionVolume, Name: &nameVolume, } request.Body = &model.UpdateVolumeRequestBody{ Volume: volumebody, } response, err := client.UpdateVolume(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。