Updating an EVS Disk (Deprecated)

Function

This API is used to update the name and description of an EVS disk.

This API has been deprecated. Use another API. For details, see Updating an EVS Disk.

URI

• URI format

  PUT /v2/{project_id}/cloudvolumes/{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 new name of the disk. Parameters name and description cannot be null at the same time. The value can contain a maximum of 255 bytes.
  description	String	No	Specifies the new description of the disk. name and description cannot be null at the same time. The value can contain a maximum of 255 bytes.

• Example request

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

Response

• Parameter description

  Parameter	Type	Description
  id	String	Specifies the disk ID.
  links	Array of objects	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	Array of objects	Specifies the disk attachment information. For details, see Parameters in the attachments field.
  availability_zone	String	Specifies the AZ to which the disk belongs.
  source_volid	String	Specifies the source disk ID. This parameter has a value if the disk is created from a source disk. Currently, this field is not supported by EVS.
  snapshot_id	String	Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot.
  description	String	Specifies the disk description.
  os-vol-tenant-attr:tenant_id	String	Specifies the ID of the tenant to which the disk belongs. Currently, the returned parameter value is invalid. The tenant ID is actually the project ID.
  volume_image_metadata	Object	Specifies the metadata of the disk image. Currently, the returned parameter value is invalid. NOTE: For details about volume_image_metadata, see Querying Image Details in the Image Management Service API Reference.
  created_at	String	Specifies the time when the disk was created. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
  volume_type	String	Specifies the disk type. Currently, only SSD and SAS are supported. SSD: specifies the ultra-high I/O disk type. SAS: specifies the high I/O disk type.
  size	Integer	Specifies the disk size, in GB.
  bootable	String	Specifies whether the disk is bootable. true: specifies a bootable disk. false: specifies a non-bootable disk.
  metadata	Object	Specifies the disk metadata. For details, see Parameters in the metadata field.
  os-vol-host-attr:host	String	Reserved field
  shareable	String	Specifies whether the disk is shareable. NOTE: This field is no longer used. Use multiattach.
  error	Object	Specifies the error message returned when an error occurs. For details, see Parameters in the error field.
  multiattach	Boolean	Specifies whether the disk is shareable. true: specifies a shared disk. false: specifies a non-shared disk.
  os-volume-replication:extended_status	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
  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.

• Parameters in the error field

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

• Example response

  {
      "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": "SATA", 
      "os-vol-tenant-attr:tenant_id": null, 
      "os-volume-replication:extended_status": null,
      "volume_image_metadata": null
  }

  or

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

Status Codes

• Normal

  200

Error Codes

For details, see Error Codes.