Consulta de detalles sobre un disco

Función

Esta API se utiliza para consultar detalles sobre un disco.

URI

• Formato URI

  GET /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

• Solicitud de ejemplo

  GET https://{endpoint}/v2/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214

Respuesta

• Descripción del parámetro

  Parámetro	Tipo	Descripción
  volume	Object	Especifica el disco consultado. Para obtener más información, consulte Parámetros en el campo de volumen.
  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 de volume

  Parámetro	Tipo	Descripción
  id	String
  links	list<map<String, String>>	Especifica el URI del disco. Para obtener más información, consulte Parámetros en el campo 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<map<String, String>>	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.
  source_volid	String	Especifica el ID del disco de origen. Este parámetro tiene un valor si el disco se crea a partir de un disco de origen. Se muestra información similar a la siguiente:
  snapshot_id	String	Especifica el ID de la instantánea. Este parámetro tiene un valor si el disco se crea a partir de una instantánea.
  description	String	Especifica la descripción del disco.
  os-vol-tenant-attr:tenant_id	String	Especifica el ID del inquilino al que pertenece el disco.
  volume_image_metadata	Object	Especifica los metadatos de la imagen de disco. NOTA: Para obtener más información sobre volume_image_metadata, consulte Consulta de detalles de imagen (Native OpenStack API).
  created_at	String	Especifica la hora a la que se creó el 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.
  size	Integer	Especifica el tamaño del disco, en GB.
  bootable	String	Especifica si el disco es arrancable. true: especifica un disco de arranque. false: especifica un disco no arrancable.
  metadata	Object	Especifica los metadatos del disco. Para obtener más información, consulte Parámetros en el campo de metadatos. Si metadata no contienen el campo hw:passthrough, el tipo de dispositivo de disco es VBD.
  os-vol-host-attr:host	String	El campo reservado.
  encrypted	Boolean	Se muestra información similar a la siguiente:
  updated_at	String	Especifica la hora a la que se actualizó el disco.
  os-volume-replication:extended_status	String	Campo Reservado
  replication_status	String	Campo Reservado
  os-vol-mig-status-attr:migstat	String	Campo Reservado
  consistencygroup_id	String	Campo Reservado
  os-vol-mig-status-attr:name_id	String	Campo Reservado
  shareable	Boolean	Especifica si el disco es compartible. NOTA: Este campo ya no se utiliza. Usa multiattach.
  user_id	String	Campo Reservado
  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": [ ], 
          "links": [
              {
                  "href": "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41", 
                  "rel": "self"
              }, 
              {
                  "href": "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41", 
                  "rel": "bookmark"
              }
          ], 
          "availability_zone": "az-dc-1", 
          "os-vol-host-attr:host": "az-dc-1#SSD", 
          "encrypted": false, 
          "multiattach": true, 
          "updated_at": "2016-02-03T02:19:29.895237", 
          "os-volume-replication:extended_status": null, 
          "replication_status": "disabled", 
          "snapshot_id": null, 
          "id": "591ac654-26d8-41be-bb77-4f90699d2d41", 
          "size": 40, 
          "user_id": "fd03ee73295e45478d88e15263d2ee4e", 
          "os-vol-tenant-attr:tenant_id": "40acc331ac784f34842ba4f08ff2be48", 
          "volume_image_metadata": null, 
          "os-vol-mig-status-attr:migstat": null, 
          "metadata": {}, 
          "status": "error_restoring", 
          "description": "auto-created_from_restore_from_backup", 
          "source_volid": null, 
          "consistencygroup_id": null, 
          "os-vol-mig-status-attr:name_id": null, 
          "name": "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9", 
          "bootable": "false", 
          "created_at": "2016-02-03T02:19:11.723797", 
          "volume_type": null
      }
  }

  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.