更新云硬盘

功能介绍

更新一个云硬盘的名称和描述。

调试

您可以在中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

• URI格式

  PUT /v2/{project_id}/cloudvolumes/{volume_id}

• 参数说明

  参数	是否必选	描述
  project_id	是	项目ID。 获取方法请参见获取项目ID。
  volume_id	是	云硬盘ID。

请求消息

• 请求参数

  参数	参数类型	是否必选	描述
  volume	Object	是	待修改的云硬盘信息，请参见•volume参数说明。

• volume参数说明

  参数	参数类型	是否必选	描述
  name	String	否	新的云硬盘的名字，name和description不能同时为null。最大支持255个字节。
  description	String	否	新的云硬盘的描述，name和description不能同时为null。最大支持255个字节。

• 请求样例

  {
      "volume": {
          "name": "test_volume", 
          "description": "test"
      }
  }

响应消息

• 响应参数

  参数	参数类型	描述
  id	String	云硬盘的ID。
  links	Array of objects	云硬盘uri自描述信息，请参见•links参数说明。
  name	String	云硬盘名称。
  status	String	云硬盘状态，具体请参见云硬盘状态。
  attachments	Array of objects	云硬盘的挂载信息，请参见•attachments参数说明。
  availability_zone	String	云硬盘所属的AZ信息。
  source_volid	String	源云硬盘ID，如果是从源云硬盘创建，则有值。 当前云硬盘服务不支持该字段。
  snapshot_id	String	快照ID，如果是从快照创建，则有值。
  description	String	云硬盘描述。
  os-vol-tenant-attr:tenant_id	String	云硬盘所属的租户ID，当前该参数返回值无效。租户ID就是项目ID。
  volume_image_metadata	Object	云硬盘镜像的元数据，当前该参数返回值无效。 说明： 关于“volume_image_metadata”字段的详细说明，具体请参见“镜像服务API参考”中的“查询镜像详情（OpenStack原生）”章节。
  created_at	String	云硬盘创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
  volume_type	String	云硬盘类型。 目前支持“SSD”，“SAS”三种。 “SSD”为超高IO云硬盘 “SAS”为高IO云硬盘
  size	Integer	云硬盘大小，单位为GB。
  bootable	String	是否为启动云硬盘。 true：表示为启动云硬盘。 false：表示为非启动云硬盘。
  metadata	Object	云硬盘的元数据，请参见•metadata参数说明。
  os-vol-host-attr:host	String	预留属性。
  shareable	String	是否为共享云硬盘。 说明： 该字段已经废弃，请使用multiattach。
  error	Object	出现错误时，返回的错误信息，具体请参见•error参数说明。
  multiattach	Boolean	是否为共享云硬盘。 true：表示为共享云硬盘。 false：表示为非共享云硬盘。
  os-volume-replication:extended_status	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参数说明

  参数	参数类型	描述
  hw:passthrough	String	metadata中的表示云硬盘设备类型的字段。 true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 该字段不存在时，云硬盘默认为VBD类型。
  full_clone	String	从快照创建云硬盘时，字段的值为0表示使用link克隆方式。

• error参数说明

  参数	参数类型	描述
  message	String	出现错误时，返回的错误消息。
  code	String	出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码。

• 响应样例

  {
      "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, 
      "snapshot_id": null, 
      "created_at": "2017-05-23T09:49:44.481299", 
      "volume_type": "SAS", 
      "os-vol-tenant-attr:tenant_id": null, 
      "os-volume-replication:extended_status": null,
      "volume_image_metadata": null
  }

  或

  {
      "error": {
          "message": "XXXX", 
          "code": "XXX"
      }
  }

状态码

• 正常

  200

错误码

请参考错误码。