Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ Elastic Volume Service/ Referencia de la API/ API de Cinder/ Gestión de discos/ Consulta de detalles sobre todos los discos de EVS

Actualización más reciente 2024-09-04 GMT+08:00

Ver PDF

Consulta de detalles sobre todos los discos de EVS

Función

Esta API se utiliza para consultar detalles sobre todos los discos de EVS.

Método de invocación

Para obtener más información, consulte Invocación a las API.

URI

GET /v2/{project_id}/volumes/detail

**Tabla 1** Parámetros de ruta
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	El ID del proyecto. Para obtener más información sobre cómo obtener el ID de proyecto, consulte Obtención de un ID de proyecto.

**Tabla 2** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
marker	No	String	El ID del último registro de la página anterior. El valor devuelto es el valor del elemento después de este.
name	No	String	El nombre del disco. Puede escribir hasta 85 caracteres.
limit	No	Integer	El número máximo de resultados de consulta que se pueden devolver. El valor oscila entre 1 y 1000 y el valor predeterminado es 1000. El valor devuelto no puede exceder este límite. Si tiene más de 50 discos en total, utilice este parámetro y configúrelo en 50 para mejorar la eficiencia de la consulta. Los ejemplos se proporcionan como sigue: Querying 1–50 disks: GET /v2/xxx/volumes/detail?limit=50 Querying 51–100 disks: GET /v2/xxx/volumes/detail?offset=50&limit=50
sort_key	No	String	La palabra clave en función de la cual se ordenan los resultados devueltos. El valor puede ser id, status, size, o created_at, y el valor predeterminado es created_at.
sort_dir	No	String	El orden de clasificación del resultado. El valor predeterminado es desc. desc: orden descendente asc: orden ascendente
offset	No	Integer	El desplazamiento de la consulta. Todos los discos después de este desplazamiento serán consultados. El valor debe ser un entero mayor que 0 pero menor que el número de discos.
status	No	String	El estado del disco.
metadata	No	String	Los metadatos del disco. Este parámetro se transfiere en formato de JSON, por ejemplo, GET /v2/{project_id}/volumes/detail?metadata={"hw:passthrough": "true"}.
availability_zone	No	String	La información de zona de disponibilidad.

Parámetros de solicitud

**Tabla 3** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	El token del usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario.

Response Parameters

Status code: 200

**Tabla 4** Response body parameters
Parámetro	Tipo	Descripción
volumes	Array of VolumeDetail objects	La lista de discos devueltos.
volumes_links	Array of Link objects	The query position marker in the disk list. Si solo se devuelven algunos discos en esta consulta, se devuelve la dirección URL del último disco consultado. Puede utilizar esta dirección URL para continuar consultando los discos restantes en la siguiente consulta.

**Tabla 5** VolumeDetail
Parámetro	Tipo	Descripción
id	String	El ID del disco.
links	Array of Link objects	El URI del disco.
name	String	El nombre del disco.
status	String	El estado del disco. Para obtener más detalles, consulte Estado del disco de EVS.
attachments	Array of VolumeAttachment objects	Si el disco está conectado.
availability_zone	String	La AZ a la que pertenece el disco.
source_volid	String	ID del disco de origen. Este parámetro tiene un valor si el disco se crea a partir de un disco de origen. Este campo no se admite actualmente.
snapshot_id	String	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	La descripción del disco.
bootable	String	Si el disco es arrancable. true: el disco es arrancable. false: el disco no se puede arrancar.
encrypted	Boolean	Este campo no se admite actualmente.
created_at	String	La hora en que se creó el disco. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX
volume_type	String	El tipo de disco. El valor puede ser SATA, SAS, GPSSD, SSD, ESSD, GPSSD2 o ESSD2. SATA: el tipo de E/S común (agotado) SAS: el tipo de E/S alta GPSSD: el tipo de SSD de uso general SSD: el tipo de E/S ultraalta ESSD: el tipo de SSD extrema GPSSD2: el tipo V2 de SSD de uso general ESSD2: el tipo extremo de SSD V2
replication_status	String	El campo reservado.
consistencygroup_id	String	El campo reservado.
metadata	VolumeMetadata object	Los metadatos del disco. Si metadata no contienen el campo hw:passthrough, el tipo de dispositivo de disco es VBD. Si metadata no contienen el campo __system__encrypted, el disco no está cifrado.
size	Integer	El tamaño del disco, en GiB.
user_id	String	El campo reservado.
updated_at	String	La hora en que se actualizó el disco. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX
shareable	Boolean	Si el disco se puede compartir. Nota: Este campo ha sido obsoleto. Use multiattach.
multiattach	Boolean	Si el disco se puede compartir.
os-vol-tenant-attr:tenant_id	String	El ID del tenant al que pertenece el disco. El ID del tenant es el mismo que el ID del proyecto.
volume_image_metadata	Object	Los metadatos de la imagen de disco. Para obtener más detalles sobre el campo volume_image_metadata, véase Consulta de detalles de imagen (API nativa de OpenStack).
os-vol-host-attr:host	String	El campo reservado.
os-volume-replication:extended_status	String	El campo reservado.
os-vol-mig-status-attr:migstat	String	El campo reservado.
os-vol-mig-status-attr:name_id	String	El campo reservado.
iops	iops object	La información de IOPS del disco. Este parámetro se devuelve solo para un disco de SSD V2 de propósito general o un disco de SSD V2 extremo.
throughput	throughput object	La información del throughput del disco. Este parámetro se devuelve solo para un disco de SSD V2 de uso general.

**Tabla 6** VolumeAttachment
Parámetro	Tipo	Descripción
attached_at	String	La hora a la que se ha conectado el disco. Formato de hora: UTC AAAA-MM-DDTHH:MM:SS.XXXXXX
attachment_id	String	El ID del archivo adjunto.
device	String	El nombre del dispositivo.
host_name	String	El nombre del host físico que alberga el servidor en la nube al que está conectado el disco.
id	String	El ID del disco conectado.
server_id	String	El ID del servidor al que está conectado el disco.
volume_id	String	El ID del disco.

**Tabla 7** VolumeMetadata
Parámetro	Tipo	Descripción
__system__cmkid	String	El ID de CMK de encriptación de metadata. Este parámetro se utiliza junto con __system__encrypted para la encriptación. La longitud de cmkid se fija en 36 bytes. NOTA: Utilice una solicitud de HTTPS para obtener el ID de clave. Para obtener más detalles, consulte Consulta de la lista de claves.
__system__encrypted	String	El campo de encriptación de metadata. El valor puede ser 0 (sin encriptación) o 1 (encriptación). Si este parámetro no aparece, el disco no está cifrado.
full_clone	String	Si el disco se crea a partir de una instantánea y es necesario utilizar la clonación vinculada, establezca este parámetro en 0.
hw:passthrough	String	Si este parámetro se establece en true, el tipo de dispositivo de disco es SCSI, lo que permite que los sistemas operativos de ECS accedan directamente a los medios de almacenamiento subyacentes. Se admiten comandos de reserva SCSI. Si este parámetro se establece en false, el tipo de dispositivo de disco es VBD, que también es el tipo predeterminado. VBD solo admite los comandos simples de lectura/escritura de SCSI. Si este parámetro no está disponible, el tipo de dispositivo de disco es VBD.

**Tabla 8** iops
Parámetro	Tipo	Descripción
frozened	Boolean	La etiqueta congelada. Predeterminado: false
id	String	El ID del IOPS del disco.
total_val	Integer	Las IOPS.
volume_id	String	El ID del disco.

**Tabla 9** throughput
Parámetro	Tipo	Descripción
frozened	Boolean	La etiqueta congelada. Predeterminado: false
id	String	El ID del throughput.
total_val	Integer	El throughput.
volume_id	String	El ID del disco.

**Tabla 10** Enlace
Parámetro	Tipo	Descripción
href	String	El enlace de acceso directo correspondiente.
rel	String	El nombre del marcador de enlace de acceso directo. Valor predeterminado: next

Código de estado: 400

**Tabla 11** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
error	Error object	El mensaje de error devuelto si se produce un error.

**Tabla 12** Error
Parámetro	Tipo	Descripción
code	String	El código de error devuelto si se produce un error. Para obtener más detalles sobre los códigos de error y sus significados, consulte Códigos de error.
message	String	El mensaje de error devuelto si se produce un error.

Ejemplo de solicitudes

GET https://{endpoint}/v2/{project_id}/volumes/detail

Ejemplo de respuestas

Código de estado: 200

Aceptar

{
  "volumes" : [ {
    "attachments" : [ ],
    "availability_zone" : "az-dc-1",
    "bootable" : "false",
    "created_at" : "2016-05-25T02:42:10.856332",
    "encrypted" : false,
    "id" : "b104b8db-170d-441b-897a-3c8ba9c5a214",
    "links" : [ {
      "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
      "rel" : "self"
    }, {
      "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
      "rel" : "bookmark"
    } ],
    "metadata" : { },
    "name" : "zjb_u25_test",
    "os-vol-host-attr:host" : "pod01.xxx#SATA",
    "volume_image_metadata" : { },
    "os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f",
    "replication_status" : "disabled",
    "multiattach" : false,
    "size" : 1,
    "status" : "available",
    "updated_at" : "2016-05-25T02:42:22.341984",
    "user_id" : "b0524e8342084ef5b74f158f78fc3049",
    "volume_type" : "SATA",
    "consistencygroup_id" : null,
    "os-vol-mig-status-attr:migstat" : null,
    "os-vol-mig-status-attr:name_id" : null,
    "snapshot_id" : null,
    "source_volid" : null
  } ],
  "volumes_links" : [ {
    "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214",
    "rel" : "next"
  } ]
}

Código de estado: 400

Error en la solicitud

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

Códigos de estado

Código de estado	Descripción
200	Aceptar
400	Error en la solicitud

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de discos

Tema anterior: Consulta de detalles sobre un disco de EVS

Tema siguiente: Consulta de las API de extensión

Comentarios

¿Le pareció útil esta página?

Sí No

Deje algún comentario

Muchas gracias por sus comentarios. Seguiremos trabajando para mejorar la documentación.

El sistema está ocupado. Vuelva a intentarlo más tarde.

¿Cuáles de los siguientes problemas se presentaron?

Contenido diferente a la de la IU del producto

Descripciones poco claras

Falta de ejemplos o código

Pasos incorrectos

No puedo encontrar lo que necesito

Falta de prácticas recomendadas

Comentarios (opcional)

0/500

Seleccione al menos un tipo de problema e ingrese sus comentarios o sugerencias.

Ingrese 500 caracteres como máximo.

Enviar Cancelar