Actualización de un disco de EVS

Función

Esta API se utiliza para actualizar la información del disco EVS.

URI

• Formato URI

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

• Descripción del parámetro

  Parámetro	Obligatorio	Descripción
  project_id	Sí	Especifica el ID del proyecto. Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.
  volume_id	Sí	Especifica el ID de disco.

Solicitud

• Descripción del parámetro

  Parámetro	Tipo	Obligatorio	Descripción
  volume	Object	Sí	Especifica la información del disco que se va a actualizar. Para obtener más información, consulte Parámetros en el campo de volumen.

• Parámetros en el campo de volume

  Parámetro	Tipo	Obligatorio	Descripción
  name	String	No	Especifica el nombre del disco.
  description	String	No	Especifica la descripción del disco.
  metadata	Object	No	Especifica los metadatos del disco.
  display_name	String	No	Especifica también el nombre del disco. Puede especificar el nombre del parámetro name o display_name. Si se especifican ambos parámetros, se utiliza el valor de name.
  display_description	String	No	Especifica también la descripción del disco. Puede especificar la descripción del parámetro o la description o display_description. Si se especifican ambos parámetros, se utiliza el valor de description.

• Solicitud de ejemplo

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

Respuesta

• Descripción del parámetro

  Parámetro	Tipo	Descripción
  volume	Object	Especifica la información del disco actualizado. Para obtener más información, consulte Parámetros en el campo volumes.
  error	Object	Especifica el mensaje de error devuelto cuando se produce un error. Para obtener más información, consulte Parámetros en el campo de error.

• Parámetros en el campo volumes

  Parámetro	Tipo	Descripción
  id	String	Especifica el ID de disco.
  links	list<map<String,String>>	Especifica el URI del disco. Para obtener más información, consulte Parámetros en el campo de Enlaces.
  name	String	Especifica el nombre del disco.
  status	String	Especifica el estado del disco. Para más detalles, consulte Estado de disco EVS.
  attachments	list	Especifica la información de datos adjuntos del disco. Para obtener más información, consulte Parámetros en el campo de datos adjuntos.
  availability_zone	String	Especifica la zona de disponibilidad al que pertenece el disco.
  bootable	String	Especifica si el disco es arrancable. true: especifica un disco de arranque. false: especifica un disco no arrancable.
  encrypted	Boolean	Se muestra información similar a la siguiente:
  created_at	String	Especifica la hora a la que se creó el disco.
  description	String	Especifica la descripción del disco.
  volume_type	String	Especifica el tipo de disco. Currently, the value can be SSD, GPSSD, or SAS. SSD: specifies the ultra-high I/O disk type. GPSSD: specifies the general purpose SSD disk type. SAS: specifies the high I/O disk type.
  replication_status	String	El campo reservado.
  consistencygroup_id	String	El campo reservado.
  source_volid	String	Especifica el ID del disco de origen. Se muestra información similar a la siguiente:
  snapshot_id	String	Especifica el ID de la instantánea.
  metadata	Object	Especifica los metadatos del disco. Para obtener más información, consulte Parámetros en el campo de metadatos.
  size	Integer	Especifica el tamaño del disco, en GB.
  user_id	String	Campo Reservado
  updated_at	String	Especifica la hora a la que se actualizó el disco.
  shareable	Boolean	Especifica si el disco es compartible. NOTA: Este campo ya no se utiliza. Usa multiattach.
  multiattach	Boolean	Especifica si el disco es compartible. true: especifica un disco compartido. false: especifica un disco no compartido.
  storage_cluster_id	String	Campo Reservado

• Parámetros en el campo links

  Parámetro	Tipo	Descripción
  href	String	Especifica el enlace de acceso directo correspondiente.
  rel	String	Especifica el nombre del marcador de enlace de acceso directo.

• Parámetros en el campo attachments

  Parámetro	Tipo	Descripción
  server_id	String	Especifica el ID del servidor al que está conectado el disco.
  attachment_id	String	Especifica ID de la información de datos adjuntos.
  attached_at	String	Especifica la hora a la que se ha conectado el disco.
  host_name	String	Especifica el nombre del host físico que aloja el servidor al que está conectado el disco.
  volume_id	String	Especifica el ID de disco.
  device	String	Especifica el nombre del dispositivo.
  id	String	Especifica el ID del recurso adjunto.

• 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. If this parameter is specified, the disk is billed on a yearly/monthly basis. If this parameter is not specified, the disk is billed on a pay-per-use basis.

• Parámetros en el campo de error

  Parámetro	Tipo	Descripción
  message	String	Especifica el mensaje de error devuelto cuando se produce un error.
  code	String	Especifica el código de error devuelto cuando se produce un error. Para obtener más información sobre el código de error, consulte Códigos de error.

• Ejemplo de respuesta

  {
      "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"
      }
  }

  o

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

  En el ejemplo anterior, error indica un error general, por ejemplo, badRequest o itemNotFound. Un ejemplo es el siguiente:

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

Códigos de estado

• Normal

  200

Códigos de error

Para más detalles, consulte Códigos de error.