Updating an EVS Disk

Function

This API is used to update the EVS disk information.

URI

• URI format

  PUT /v2/{project_id}/volumes/{volume_id}

• Parameter description

  Parameter	Mandatory	Description
  project_id	Yes	Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
  volume_id	Yes	Specifies the disk ID.

Request

• Parameter description

  Parameter	Type	Mandatory	Description
  volume	Object	Yes	Specifies the information of the disk to be updated. For details, see Parameters in the volume field.

• Parameters in the volume field

  Parameter	Type	Mandatory	Description
  name	String	No	Specifies the disk name. The value can contain a maximum of 255 bytes.
  description	String	No	Specifies the disk description. The value can contain a maximum of 255 bytes.
  metadata	Object	No	Specifies the disk metadata. The length of the key or value in the metadata cannot exceed 255 bytes.
  display_name	String	No	Specifies also the disk name. You can specify either parameter name or display_name. If both parameters are specified, the name value is used. The value can contain a maximum of 255 bytes.
  display_description	String	No	Specifies also the disk description. You can specify either parameter description or display_description. If both parameters are specified, the description value is used. The value can contain a maximum of 255 bytes.

• Example request

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

Response

• Parameter description

  Parameter	Type	Description
  volume	Object	Specifies the information of the updated disk. For details, see Parameters in the volumes field.
  error	Object	Specifies the error message returned when an error occurs. For details, see Parameters in the error field.

• Parameters in the volumes field

  Parameter	Type	Description
  id	String	Specifies the disk ID.
  links	list<map<String,String>>	Specifies the disk URI. For details, see Parameters in the links field.
  name	String	Specifies the disk name.
  status	String	Specifies the disk status. For details, see EVS Disk Status.
  attachments	list	Specifies the disk attachment information. For details, see Parameters in the attachments field.
  availability_zone	String	Specifies the AZ to which the disk belongs.
  bootable	String	Specifies whether the disk is bootable. true: specifies a bootable disk. false: specifies a non-bootable disk.
  encrypted	Boolean	This field is currently not supported.
  created_at	String	Specifies the time when the disk was created. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
  description	String	Specifies the disk description.
  volume_type	String	Specifies the disk type. The value can be SSD, GPSSD, or SAS. SSD: the ultra-high I/O type GPSSD: the general purpose SSD type SAS: the high I/O type
  replication_status	String	The reserved field.
  consistencygroup_id	String	The reserved field.
  source_volid	String	Specifies the source disk ID. This field is currently not supported.
  snapshot_id	String	Specifies the snapshot ID.
  metadata	Object	Specifies the disk metadata. For details, see Parameters in the metadata field.
  size	Integer	Specifies the disk size, in GB.
  user_id	String	Reserved field
  updated_at	String	Specifies the time when the disk was updated. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
  shareable	Boolean	Specifies whether the disk is shareable. NOTE: This field is no longer used. Use multiattach.
  multiattach	Boolean	Specifies whether the disk is shareable. true: specifies a shared disk. false: specifies a non-shared disk.
  storage_cluster_id	String	Reserved field

• Parameters in the links field

  Parameter	Type	Description
  href	String	Specifies the corresponding shortcut link.
  rel	String	Specifies the shortcut link marker name.

• Parameters in the attachments field

  Parameter	Type	Description
  server_id	String	Specifies the ID of the server to which the disk is attached.
  attachment_id	String	Specifies the ID of the attachment information.
  attached_at	String	Specifies the time when the disk was attached. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
  host_name	String	Specifies the name of the physical host accommodating the server to which the disk is attached.
  volume_id	String	Specifies the disk ID.
  device	String	Specifies the device name.
  id	String	Specifies the ID of the attached resource.

• Parameters in the metadata field

  Parameter	Type	Description
  __system__encrypted	String	Specifies the parameter that describes the encryption function in metadata. The value can be 0 or 1. 0: indicates the disk is not encrypted. 1: indicates the disk is encrypted. If this parameter does not appear, the disk is not encrypted by default.
  __system__cmkid	String	Specifies the encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes.
  hw:passthrough	String	Specifies the parameter that describes the disk device type in metadata. The value can be true or false. If this parameter is set to true, the disk device type is SCSI, which allows ECS OSs to directly access the underlying storage media and supports SCSI reservation commands. If this parameter is set to false, the disk device type is VBD (the default type), that is, Virtual Block Device (VBD), which supports only simple SCSI read/write commands. If this parameter does not appear, the disk device type is VBD.
  full_clone	String	Specifies the clone method. When the disk is created from a snapshot, the parameter value is 0, indicating the linked cloning method.
  orderID	String	Specifies the parameter that describes the disk billing mode in metadata.

• Parameters in the error field

  Parameter	Type	Description
  message	String	The error message returned if an error occurs.
  code	String	The error code returned if an error occurs. For details about the error code, see Error Codes.

• Example response

  {
      "volume": {
          "attachments": [ ], 
          "availability_zone": "az-dc-1", 
          "bootable": "false", 
          "consistencygroup_id": null, 
          "created_at": "2016-05-25T02:38:40.392463", 
          "description": "create for api test", 
          "encrypted": false, 
          "id": "8dd7c486-8e9f-49fe-bceb-26aa7e312b66", 
          "links": [
              {
                  "href": "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66", 
                  "rel": "self"
              }, 
              {
                  "href": "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66", 
                  "rel": "bookmark"
              }
          ], 
          "metadata": {
              "volume_owner": "openapi"
          }, 
          "name": "openapi_vol01", 
          "replication_status": "disabled", 
          "multiattach": false, 
          "size": 40, 
          "snapshot_id": null, 
          "source_volid": null, 
          "status": "creating", 
          "updated_at": null, 
          "user_id": "39f6696ae23740708d0f358a253c2637", 
          "volume_type": "SAS"
      }
  }

  or

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

  In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:

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

Status Codes

• Normal

  200

Error Codes

For details, see Error Codes.