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 Cloud Server/ Referencia de la API/ API de OpenStack Nova/ Gestión del ciclo de vida/ Consulta de detalles sobre ECS

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

Consulta de detalles sobre ECS

Función

Esta API se utiliza para consultar detalles sobre ECS.

URI

GET /v2.1/{project_id}/servers/detail?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}&not-tags={not-tags}&reservation_id={reservation_id}&ip={ip}

Tabla 1 describe los parámetros en el URI.

**Tabla 1** Parámetros de ruta
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, consulte Obtención de un ID de proyecto.

**Tabla 2** Query parameters
Parámetro	Obligatorio	Tipo	Descripción
changes-since	No	String	Especifica la marca de tiempo de la última actualización de estado de ECS, que se utiliza para filtrar los ECS con estados actualizados más tarde que la marca de tiempo. El formato debe cumplir con la norma ISO 8601 in the format of CCYY-MM-DDThh:mm:ss+/-hh:mm, por ejemplo, 2018-01-17T03:03:32Z.
image	No	String	Especifica el ID de imagen. Cuando la imagen se utiliza como criterio de filtro, no se admiten otros criterios de filtro ni criterios de paginación. Si se especifican tanto la imagen como otros criterios de filtro, se utiliza el criterio de filtro de imagen. Si los criterios de consulta no contienen el criterio de filtro de imagen, las funciones de la API no están restringidas.
flavor	No	String	Especifica el ID de variante de ECS, que coincide de forma difusa.
name	No	String	Especifica el nombre de ECS, que coincide con una coincidencia difusa.
status	No	String	Especifica el estado de ECS. Opciones: ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, y VERIFY_RESIZE En la microversión 2.37, el sistema devolverá una lista vacía para el campo status de las opciones anteriores. En la microversión 2.38 y posteriores, el sistema devolverá el error 400. Para más detalles, consulte Estados de ECS.
limit	No	Integer	Especifica el límite superior del número de resultados devueltos. Cada página contiene 25 ECS de forma predeterminada y se devuelve un máximo de 1000 ECS. Para grandes volúmenes de datos, se recomienda establecer el valor en 100.
marker	No	String	Especifica el identificador de ECS al que apunta el marcador. La consulta comenzará a partir de su siguiente ID.
tags	No	String	Consulta ECS con etiquetas que contienen el valor especificado.
not-tags	No	String	Consulta ECS con etiquetas que no contienen el valor especificado. El valor es la clave de etiqueta. NOTA: Las funciones de etiqueta se han actualizado en la nube pública. Si las etiquetas agregadas antes de la actualización de la función tienen el formato de "Key.Value", las etiquetas de consulta con "Key". Por ejemplo, una etiqueta existente es a.b. Después de la actualización de la función de etiqueta, consulte la etiqueta usando "not-tags=a".
reservation_id	No	String	Especifica el ID devuelto cuando se crean ECS por lotes. Este parámetro se utiliza para consultar los ECS creados por lotes.
sort_key	No	String	Ordena los resultados de la consulta por atributo de ECS. El orden de clasificación predeterminado es el orden inverso created_at. El valor puede ser created_at, auto_disk_config, availability_zone, display_description, display_name, host, host_name, image_ref, instance_type_id, kernel_id, key_name, launch_index, launched_at, locked_by, node, power_state, project_id, ramdisk_id, reservation_id, root_device_name, task_state, terminated_at, user_id, updated_at, uuid, o vm_state.
ip	No	String	Indica el resultado del filtrado para las direcciones IPv4, que coinciden difusamente.

Solicitud

No hay

Respuesta

Tabla 3 describe los parámetros de respuesta.

**Tabla 3** Parámetros de respuesta
Parámetro	Tipo	Descripción
servers	Array of objects	Especifica los ECS que se van a consultar. Para más detalles, consulte Tabla 4.
servers_links	Array of objects	Especifica el enlace de la página siguiente en la consulta de paginación. Para más detalles, consulte Tabla 6.

**Tabla 4** Descripción del campo **servers**
Parámetro	Tipo	Descripción
name	String	Especifica el nombre de ECS.
id	String	Especifica el ECS único.
status	String	Especifica el estado de ECS. Opciones: ACTIVE, BUILD, DELETED, ERROR, HARD_REBOOT, MIGRATING, PAUSED, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, SHELVED, SHELVED_OFFLOADED, SOFT_DELETED, SUSPENDED, y VERIFY_RESIZE Para más detalles, consulte Estados de ECS.
created	String	Especifica la hora en la que se creó ECS. El tiempo está en el formato de "2019-05-22T07:48:53Z".
updated	String	Especifica la hora en la que se actualizó el ECS la última vez. El tiempo está en el formato de "2019-05-22T07:48:53Z".
flavor	Object	Especifica la variante de ECS. Para más detalles, consulte Tabla 5.
image	Object	Especifica la información de la imagen de ECS. Para un ECS creado por una imagen, se devuelve el ID de imagen y su enlace. Para más detalles, consulte Tabla 11.
tenant_id	String	Especifica el ID del inquilino al que pertenece ECS. El valor del parámetro es el mismo que el ID del proyecto especificado por project_id.
key_name	String	Especifica el nombre de clave SSH.
user_id	String	Especifica el ID del usuario al que pertenece un ECS.
metadata	Object	Especifica los metadatos de ECS.
hostId	String	Especifica el ID de host del ECS.
addresses	Object	Especifica las direcciones de red de un ECS. La estructura es Map<String, Object>. La clave indica el ID de subred de VPC. El valor indica los atributos de red especificados en Tabla 7.
security_groups	Array of objects	Especifica los grupos de seguridad a los que pertenece ECS. Para más detalles, consulte Tabla 9.
links	Array of objects	Especifica los enlaces de acceso directo de ECS. Para más detalles, consulte Tabla 6.
os:scheduler_hints	Object	Especifica la información de programación de ECS. Para más detalles, consulte Tabla 12. Este parámetro solo está disponible para DeHs.
OS-DCF:diskConfig	String	Especifica el modo de configuración del disco. Este es un atributo extendido. Este campo es válido para los ECS iniciados usando una imagen. Opciones: AUTO: Esta API utiliza una sola partición para construir un ECS con el tamaño de disco de destino. La API ajusta automáticamente el sistema de archivos para que se adapte a toda la partición. MANUAL: Esta API utiliza el esquema de particionamiento en la imagen de origen y el sistema de archivos para construir el ECS. Si el tamaño del disco de destino es grande, la API no particiona el espacio restante en disco.
OS-EXT-AZ:availability_zone	String	Especifica el ID de AZ. Este es un atributo extendido.
OS-EXT-SRV-ATTR:host	String	Especifica el nombre del host en el que se implementa el ECS. Este es un atributo extendido.
OS-EXT-SRV-ATTR:hypervisor_hostname	String	Especifica el nombre de host del hipervisor. Este es un atributo extendido.
OS-EXT-SRV-ATTR:instance_name	String	Especifica el ID de ECS. Este es un atributo extendido.
OS-EXT-STS:power_state	Integer	Especifica el estado de la energía de ECS. Este es un atributo extendido. Opciones: 0, 1, 2, 3 y 4 0: pendiente 1: en ejecución 2: pausado 3: apagado 4: se estrelló
OS-EXT-STS:task_state	String	Especifica el estado de la tarea de ECS. Este es un atributo extendido. Para obtener más información sobre las opciones, consulte Estados de ECS.
OS-EXT-STS:vm_state	String	Especifica el estado de ECS. Este es un atributo extendido. Opciones: ACTIVE, BUILDING, STOPPED, RESIZED, PAUSED, SUSPENDED, RESCUED, ERROR, DELETED, SOFT_DELETED, SHELVED, y SHELVED_OFFLOADED Para más detalles, consulte Estados de ECS.
OS-SRV-USG:launched_at	String	Especifica la hora en la que se inició ECS. Este es un atributo extendido. El tiempo está en el formato de "2019-05-22T07:48:19.000000".
OS-SRV-USG:terminated_at	String	Especifica la hora a la que se eliminó ECS. Este es un atributo extendido. El tiempo está en el formato de "2019-05-22T07:48:19.000000".
os-extended-volumes:volumes_attached	Array of objects	Especifica información acerca de los discos EVS conectados al ECS. Para más detalles, consulte Tabla 8.
fault	Object	Describe las fallas de ECS. Este parámetro es opcional. Se devuelve cuando se produce un error en un ECS. Para más detalles, consulte Tabla 10.
description	String	Describe el ECS. Este parámetro está soportado en la microversión 2.19 y posteriores.
host_status	String	Especifica el estado de nova-compute. UP: El estado de nova-compute es normal. UNKNOWN: El estado de nova-compute es desconocido. DOWN: el estado de nova-computación es anormal. MAINTENANCE: El nova-compute se encuentra en estado de mantenimiento. Cadena vacía: No hay información de host en el ECS. Este parámetro está soportado en la microversión 2.16 y posteriores.
OS-EXT-SRV-ATTR:hostname	String	Especifica el nombre del host que aloja el ECS. Este parámetro es compatible con la microversión 2.3 y posteriores.
OS-EXT-SRV-ATTR:reservation_id	String	Especifica el ID reservado de ECS si se crean varios ECS por lotes. Este parámetro es compatible con la microversión 2.3 y posteriores.
OS-EXT-SRV-ATTR:launch_index	Integer	Especifica la secuencia en la que se crean los ECS en un inicio por lotes. Este parámetro es compatible con la microversión 2.3 y posteriores.
OS-EXT-SRV-ATTR:kernel_id	String	Especifica el UUID de la imagen del núcleo si se utiliza una imagen AMI. En otros escenarios, deje este parámetro en blanco. Este parámetro es compatible con la microversión 2.3 y posteriores.
OS-EXT-SRV-ATTR:ramdisk_id	String	Especifica el UUID de la imagen Ramdisk si se utiliza una imagen AMI. En otros escenarios, deje este parámetro en blanco. Este parámetro es compatible con la microversión 2.3 y posteriores.
OS-EXT-SRV-ATTR:root_device_name	String	Especifica el nombre del dispositivo del disco del sistema de ECS. Este parámetro es compatible con la microversión 2.3 y posteriores.
OS-EXT-SRV-ATTR:user_data	String	Especifica los datos de usuario especificados durante la creación de ECS. Este parámetro es compatible con la microversión 2.3 y posteriores.
tags	Array of strings	Especifica las etiquetas de ECS. Este parámetro está soportado en la microversión 2.26 y posteriores. Si la microversión no se utiliza para la consulta, la respuesta no contiene el campo tags. Las funciones de etiqueta se han actualizado en la nube pública. Después de la actualización, los valores de etiqueta devueltos por el sistema cumplen las siguientes reglas: La clave y el valor de una etiqueta se conectan usando un signo igual (=), por ejemplo, clave=valor. Si el valor está vacío, solo se devuelve la clave.
locked	Boolean	Especifica el estado de bloqueo de ECS, que es True cuando ECS está bloqueado y False cuando ECS está desbloqueado. Este parámetro está soportado en la microversión 2.9 y posteriores.
accessIPv4	String	Reservada
accessIPv6	String	Reservada
config_drive	String	Reservada
progress	Integer	Reservada

**Tabla 5** Descripción del campo **flavor**
Parámetro	Tipo	Descripción
id	String	Especifica el ID de ECS. Este parámetro no es compatible con la microversión 2.47 y posteriores.
links	Array of objects	Especifica los enlaces de acceso directo para los tipos de ECS. Para más detalles, consulte Tabla 6. Este parámetro no es compatible con la microversión 2.47 y posteriores.
vcpus	Integer	Especifica el número de vCPU en la variante de ECS. Este parámetro está soportado en la microversión 2.47 y posteriores.
ram	Integer	Especifica el tamaño de memoria (MB) en la variante de ECS. Este parámetro está soportado en la microversión 2.47 y posteriores.
disk	Integer	Especifica el tamaño del disco del sistema en la variante de ECS. El valor 0 indica que el tamaño del disco no está limitado. Este parámetro está soportado en la microversión 2.47 y posteriores.
ephemeral	Integer	Reservada Este parámetro está soportado en la microversión 2.47 y posteriores.
swap	Integer	Reservada Este parámetro está soportado en la microversión 2.47 y posteriores.
original_name	String	Especifica el nombre de la variante de ECS. Este parámetro está soportado en la microversión 2.47 y posteriores.
extra_specs	Object	Campo de variante extendida Para más detalles, consulte Estructura de datos para detalles de consulta acerca de las especificaciones. Este parámetro está soportado en la microversión 2.47 y posteriores.

**Tabla 6** Descripción del campo **servers_links** y **links**
Parámetro	Tipo	Descripción
rel	String	Especifica el nombre del marcador de enlace de acceso directo.
href	String	Especifica el enlace de acceso directo.

**Tabla 7** Estructura de datos de la red a la que accede un ECS
Parámetro	Tipo	Descripción
addr	String	Especifica la dirección IP.
version	Integer	Especifica el tipo de dirección IP. El valor de este parámetro puede ser 4 o 6. 4: El tipo de dirección IP es IPv4. 6: El tipo de dirección IP es IPv6.
OS-EXT-IPS-MAC:mac_addr	String	Especifica la dirección MAC. Este es un atributo extendido.
OS-EXT-IPS:type	String	Especifica el modo de asignación de direcciones IP. Este es un atributo extendido.

**Tabla 8** Descripción del campo **os-extended-volumes:volumes_attached**
Parámetro	Tipo	Descripción
id	String	Especifica el ID de disco de EVS.
delete_on_termination	Boolean	Especifica si se eliminarán discos adicionales al eliminar el ECS. De forma predeterminada, este parámetro se establece en False. Este parámetro es compatible con la microversión 2.3 y posteriores.

**Tabla 9** Descripción del campo **security_groups**
Parámetro	Tipo	Descripción
name	String	Especifica el nombre del grupo de seguridad o UUID.

**Tabla 10** Descripción del campo **fault**
Parámetro	Tipo	Descripción
code	Integer	Especifica el código de error.
created	String	Especifica la hora en que se produjo un error.
message	String	Describe un error.
details	String	Especifica los detalles acerca de un error. Este parámetro es opcional y solo se devuelve cuando no está vacío.

**Tabla 11** Descripción del campo **image**
Parámetro	Tipo	Descripción
id	String	Especifica el ID de imagen.
links	Array of objects	Especifica los vínculos de acceso directo para las imágenes ECS. Para más detalles, consulte Tabla 6.

**Tabla 12** Parámetros **os:scheduler_hints**
Parámetro	Obligatorio	Tipo	Descripción
tenancy	No	Array of strings	Crea los ECS en un host dedicado o compartido. El valor de este parámetro puede ser dedicated o shared.
dedicated_host_id	No	Array of strings	Especifica el ID de DeH. Este parámetro solo tiene efecto cuando tenancy se establece en dedicated.

Ejemplo de la solicitud

GET https://{endpoint}/v2.1/{project_id}/servers/detail

Ejemplo de la respuesta

{
    "servers": [
        {
            "addresses": {
                "68269e6e-4a27-441b-8029-35373ad50bd9": [
                    {
                        "addr": "192.168.0.3", 
                        "version": 4
                    }
                ]
            }, 
            "created": "2012-09-07T16:56:37Z", 
            "flavor": {
                "id": "1", 
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/flavors/1", 
                        "rel": "bookmark"
                    }
                ]
            }, 
            "hostId": "16d193736a5cfdb60c697ca27ad071d6126fa13baeb670fc9d10645e", 
            "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931", 
            "image": "", 
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931", 
                    "rel": "self"
                }, 
                {
                    "href": "http://openstack.example.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931", 
                    "rel": "bookmark"
                }
            ], 
            "metadata": {},                         
            "name": "new-server-test", 
            "progress": 0, 
            "status": "ACTIVE", 
            "tenant_id": "openstack", 
            "updated": "2012-09-07T16:56:37Z", 
            "user_id": "fake"
        }
    ]
}