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> OpenStack Cinder API v2> EVS Disk> Consulta de detalles sobre todos los discos

Actualización más reciente 2022-11-15 GMT+08:00

Ver PDF

Consulta de detalles sobre todos los discos

Función

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

URI

Formato URI
GET /v2/{project_id}/volumes/detail

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.

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.

Parámetros de filtro de solicitud

Parámetro	Tipo	Obligatorio	Descripción
marker	String	No
name	String	No	Especifica el nombre del disco.
limit	Integer	No	Especifica el número máximo de resultados de consulta que se pueden devolver. Si el inquilino tiene más de 50 discos en total, se recomienda utilizar este parámetro y establecer su valor en 50 para mejorar la eficiencia de la consulta. Los ejemplos se proporcionan como sigue: GET /v2/xxx/volumes/detail?limit=50: Consulta los discos 1-50. GET /v2/xxx/volumes/detail?offset=50&limit=50: Consulta los discos 51-100.
sort_key	String	No	Especifica 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	String	No	Especifica el orden de clasificación del resultado. El valor predeterminado es desc. desc: indica el orden descendente. asc: indica el orden ascendente.
offset	Integer	No	Especifica el desfase. 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	String	No	Especifica el estado del disco. Para más detalles, consulte Estado de disco EVS.
metadata	String	No	Especifica los metadatos del disco.
availability_zone	String	No	Especifica la AZ.

Solicitud

En el ejemplo siguiente se muestra cómo consultar los detalles de los discos en el estado available.

Solicitud de ejemplo

GET https://{endpoint}/v2/{project_id}/volumes/detail?status=available

Respuesta

Descripción del parámetro

Parámetro	Tipo	Descripción
volumes	list	Especifica la lista de discos consultados. Para obtener más información, consulte Parámetros en el campo volumes.
volumes_links	list	Especifica el marcador de posición de la consulta en la lista de discos. Si solo se devuelven algunos discos en esta consulta, se devolverá la URL del último disco consultado. Puede utilizar esta dirección URL para continuar consultando los discos restantes en la siguiente consulta. Para obtener más información, consulte Parámetros en el campo de Enlaces.
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.
os-vol-host-attr:host	String
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.
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.
os-vol-tenant-attr:tenant_id	String	Especifica el ID del inquilino al que pertenece el disco.
size	Integer	Especifica el tamaño del disco, en GB.
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-mig-status-attr:migstat	String	El campo reservado.
os-vol-mig-status-attr:name_id	String	El campo reservado.
os-volume-replication:extended_status	String	El campo reservado.
encrypted	Boolean	Se muestra información similar a la siguiente:
replication_status	String	El campo reservado.
user_id	String	Campo Reservado
consistencygroup_id	String	Especifica el identificador del grupo de consistencia al que pertenece el disco. Se muestra información similar a la siguiente:
bootable	String	Especifica si el disco es arrancable. true: especifica un disco de arranque. false: especifica un disco no arrancable.
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.
volume_image_metadata	Object	Especifica los metadatos de la imagen de disco. Este campo tiene un valor si el disco se crea a partir de una imagen. De lo contrario, se deja vacío. NOTA: Para obtener más información sobre volume_image_metadata, consulte Consulta de detalles de imagen (Native OpenStack API).

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.

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

{
    "volumes": [
        {
            "attachments": [ ], 
            "availability_zone": "az-dc-1", 
            "bootable": "false", 
            "consistencygroup_id": null, 
            "created_at": "2016-05-25T02:42:10.856332", 
            "description": null, 
            "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#SAS", 
            "volume_image_metadata": { }, 
            "os-vol-mig-status-attr:migstat": null, 
            "os-vol-mig-status-attr:name_id": null, 
            "os-vol-tenant-attr:tenant_id": "dd14c6ac581f40059e27f5320b60bf2f",  
            "os-volume-replication:extended_status": null, 
            "replication_status": "disabled", 
            "multiattach": false, 
            "size": 1, 
            "snapshot_id": null, 
            "source_volid": null, 
            "status": "available", 
            "updated_at": "2016-05-25T02:42:22.341984", 
            "user_id": "b0524e8342084ef5b74f158f78fc3049", 
            "volume_type": "SAS"
        }
    ], 
    "volumes_links": [
        {
            "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214", 
            "rel": "next"
        }
    ]
}

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

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

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

Códigos de estado

Normal
200

Códigos de error

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

Tema principal: EVS Disk

Tema anterior: Consulta de discos EVS

Tema siguiente: Consulta de detalles sobre un disco

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