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 Load Balance/ Referencia de la API/ API históricas/ API de balanceador de carga mejorado compartido (OpenStack)/ Balanceador de carga/ Consulta de los balanceadores de carga

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

Ver PDF

Consulta de los balanceadores de carga

Función

Esta API se utiliza para consultar balanceadores de carga y mostrarlos en una lista. Se admite la consulta de filtro y la consulta de paginación. A menos que se especifique lo contrario, se aplica una coincidencia exacta.

Restricciones

Los parámetros marker, limit y page_reverse se utilizan para la consulta de paginación. Los parámetros marker y page_reverse solo tienen efecto cuando se usan junto con el parámetro limit.

URI

GET /v2.0/lbaas/loadbalancers

Solicitud

**Tabla 1** Descripción del parámetro
Parámetro	Obligatorio	Tipo	Descripción
marker	No	String	Especifica el ID del balanceador de carga desde el que se inicia la consulta de paginación, es decir, el ID del último balanceador de carga de la página anterior. Este parámetro debe usarse junto con limit.
limit	No	Integer	Especifica el número de balanceadores de carga de cada página.
page_reverse	No	Boolean	Especifica la dirección de la página. El valor puede ser true o false, y el valor predeterminado es false. La última página de la lista solicitada con page_reverse establecido en false no contendrá el enlace "next", y la última página de la lista solicitada con page_reverse establecido en true no contendrá el enlace "anterior". Este parámetro debe usarse junto con limit.
tenant_id	No	String	Especifica el ID del proyecto en el que se utiliza el balanceador de carga.
project_id	No	String	Especifica el ID del proyecto al que pertenece el balanceador de carga. Este parámetro tiene el mismo significado que tenant_id.
id	No	String	Especifica el ID del balanceador de carga.
description	No	String	Proporciona información adicional sobre el balanceador de carga. El valor contiene un máximo de 255 caracteres.
name	No	String	Especifica el nombre del balanceador de carga. El valor contiene un máximo de 255 caracteres.
operating_status	No	String	Este parámetro está reservado, y su valor puede ser ONLINE o FROZEN. Especifica el estado de funcionamiento del balanceador de carga.
provisioning_status	No	String	Este parámetro está reservado y su valor sólo puede ser ACTIVE. Especifica el estado de aprovisionamiento del balanceador de carga.
admin_state_up	No	Boolean	Este parámetro está reservado, y su valor solo puede ser true. Especifica el estado administrativo del balanceador de carga.
vip_address	No	String	Especifica la dirección IP privada del balanceador de carga. El valor incluye un máximo de 64 caracteres.
vip_port_id	No	String	Especifica el ID del puerto enlazado a la dirección IP privada del balanceador de carga.
vip_subnet_id	No	String	Especifica el ID de red IPv4 de la subred en la que funciona el balanceador de carga.
member_address	No	String	Especifica la dirección IP del servidor backend asociado al balanceador de carga.
member_device_id	No	String	Especifica el ID del servidor en la nube utilizado como servidor backend asociado al balanceador de carga.
vpc_id	No	String	Especifica el ID de la VPC donde funciona el balanceador de carga.

Respuesta

**Tabla 2** Parámetros de respuesta
Parámetro	Tipo	Descripción
loadbalancers	Array	Enumera los balanceadores de carga. Para más detalles, consulte Tabla 3.
loadbalancers_links	Array	Proporciona enlaces a la página anterior o siguiente durante la consulta de paginación, respectivamente. Este parámetro solo existe en el cuerpo de respuesta de la consulta de paginación. Para más detalles, consulte Tabla 6.

**Tabla 3** Descripción de parámetro **loadbalancer**
Parámetro	Tipo	Descripción
id	String	Especifica el ID del balanceador de carga.
project_id	String	Especifica el ID del proyecto al que pertenece el balanceador de carga. Este parámetro tiene el mismo significado que tenant_id.
tenant_id	String	Especifica el ID del proyecto en el que se utiliza el balanceador de carga. El valor contiene un máximo de 255 caracteres.
name	String	Especifica el nombre del balanceador de carga. El valor contiene un máximo de 255 caracteres.
description	String	Proporciona información adicional sobre el balanceador de carga. El valor contiene un máximo de 255 caracteres.
vip_subnet_id	String	Especifica el ID de red IPv4 de la subred en la que funciona el balanceador de carga.
vip_port_id	String	Especifica el ID del puerto enlazado a la dirección IP privada del balanceador de carga. Cuando se crea un balanceador de carga, el sistema crea automáticamente un puerto y lo asocia a un grupo de seguridad. Sin embargo, el grupo de seguridad no tendrá efecto.
provider	String	Especifica el proveedor del balanceador de carga.
vip_address	String	Especifica la dirección IP privada del balanceador de carga. El valor incluye un máximo de 64 caracteres.
listeners	Array	Muestra los ID de oyentes agregados al balanceador de carga. Para más detalles, consulte Tabla 5.
pools	Array	Muestra los ID de los grupos de servidores backend asociados con el balanceador de carga. Para más detalles, consulte Tabla 6.
operating_status	String	Este parámetro está reservado, y su valor puede ser ONLINE o FROZEN. Especifica el estado de funcionamiento del balanceador de carga.
provisioning_status	String	Este parámetro está reservado y su valor sólo puede ser ACTIVE. Especifica el estado de aprovisionamiento del balanceador de carga.
admin_state_up	Boolean	Especifica el estado administrativo del balanceador de carga. Este parámetro está reservado. El valor puede ser true o false. true: habilitar false: deshabilitar
tags	Array	Enumera las etiquetas de balanceador de carga.
created_at	String	Especifica la hora en que se creó el balanceador de carga. La hora UTC está en formato AAAA-MM-DDTHH:MM:SS. El valor contiene un máximo de 19 caracteres.
updated_at	String	Especifica la hora a la que se actualizó el balanceador de carga. La hora UTC está en formato AAAA-MM-DDTHH:MM:SS. El valor contiene un máximo de 19 caracteres.

**Tabla 4** Descripción del parámetro **listeners**
Parámetro	Tipo	Descripción
id	String	Especifica el ID del oyente asociado.

**Tabla 5** Descripción del parámetro **pools**
Parámetro	Tipo	Descripción
id	String	Especifica el ID del grupo de servidores backend asociado.

**Tabla 6** Descripción de parámetro **loadbalancers_links**
Parámetro	Tipo	Descripción
href	String	Proporciona enlaces a la página anterior o siguiente durante la consulta de paginación, respectivamente.
rel	String	Especifica la solicitud de la página anterior o siguiente. El valor puede ser next o previous. El valor next indica la referencia de hipertexto (href) que contiene la dirección URL de la página siguiente, y previous indica la href que contiene la dirección URL de la página anterior.

Ejemplo de la solicitud

Ejemplo de solicitud 1: Consulta de todos los balanceadores de carga
```
GET https://{Endpoint}/v2.0/lbaas/loadbalancers
```
Ejemplo de solicitud 2: Consulta de los balanceadores de carga por página (cada página contiene un balanceador de carga. El ID del balanceador de carga inicial es 165b6a38-5278-4569-b747-b2ee65ea84a4. El balanceador de carga después de 165b6a38-5278-4569-b747-b2ee65ea84a4 es el balanceador de carga consultado)
```
GET https://{Endpoint}/v2.0/lbaas/loadbalancers?limit=1&marker=165b6a38-5278-4569-b747-b2ee65ea84a4
```
Ejemplo de solicitud 3: Consulta del balanceador de carga usando la dirección IP de un servidor backend (192.168.0.191)
```
GET https://{Endpoint}/v2.0/lbaas/loadbalancers?member_address=192.168.0.181
```

Ejemplo de la respuesta

Ejemplo de respuesta 1

{
    "loadbalancers": [
        {
            "description": "simple lb",
            "admin_state_up": true,
            "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
            "project_id": "1a3e005cf9ce40308c900bcb08e5320c",
            "provisioning_status": "ACTIVE",
            "vip_subnet_id": "5328f1e6-ce29-44f1-9493-b128a5653350",
            "listeners": [
                {
                    "id": "45196943-2907-4369-87b1-c009b1d7ac35"
                }
            ],
            "vip_address": "10.0.0.2",
            "vip_port_id": "cbced4fe-6f6f-4fd6-9348-0c3d1219d6ca",
            "provider": "vlb",
            "pools": [
                {
                    "id": "21d49cf7-4fd3-4cb6-8c48-b7fc6c259aab"
            }
            ],
            "id": "a9729389-6147-41a3-ab22-a24aed8692b2",
            "operating_status": "ONLINE",
            "tags": [],
            "name": "loadbalancer1",
            "created_at": "2018-07-25T01:54:13", 
            "updated_at": "2018-07-25T01:54:14"
        }
    ]
}

Ejemplo de respuesta 2

{
    "loadbalancers": [
        {
            "description": "",
            "provisioning_status": "ACTIVE",
            "tenant_id": "601240b9c5c94059b63d484c92cfe308",
            "project_id": "601240b9c5c94059b63d484c92cfe308",
            "admin_state_up": true,
            "provider": "vlb",
            "pools": [
                {
                    "id": "b13dba4c-a44c-4c40-8f6e-ce7a162b9f22"
                },
                {
                    "id": "4b9e765f-82ee-4128-911b-0a2d9ebc74c7"
                }
            ],
            "listeners": [
                {
                    "id": "21c41336-d0d3-4349-8641-6e82b4a4d097"
                }
            ],
            "vip_port_id": "44ac5d9b-b0c0-4810-9a9d-c4dbf541e47e",
            "operating_status": "ONLINE",
            "vip_address": "192.168.0.234",
            "vip_subnet_id": "9d60827e-0e5c-490a-8183-0b6ebf9084ca",
            "id": "e79a7dd6-3a38-429a-95f9-c7f78b346cbe",
            "tags": [],
            "name": "elb-robot",
            "created_at": "2018-07-25T01:54:13", 
            "updated_at": "2018-07-25T01:54:14"
        }
    ],
    "loadbalancers_links": [
        {
            "href": "https://network.Region.dc1.domainname.com/v2.0/lbaas/loadbalancers?limit=10&marker=e79a7dd6-3a38-429a-95f9-c7f78b346cbe&page_reverse=True",
              "rel": "previous"
        }
    ]
}

Ejemplo de respuesta 3

{
    "loadbalancers": [
        {
            "description": "",
            "provisioning_status": "ACTIVE",
            "tenant_id": "601240b9c5c94059b63d484c92cfe308",
            "project_id": "601240b9c5c94059b63d484c92cfe308",
            "created_at": "2018-11-29T13:55:20",
            "admin_state_up": true,
            "update_at": "2018-11-29T13:55:21",
            "id": "c1127125-64a9-4394-a08a-ef3be8f7ef9c",
            "pools": [
                {
                    "id": "2f6895be-019b-4c82-9b53-c4a2ac009e20"
                }
            ],
            "listeners": [
                {
                    "id": "5c63d176-444f-4c75-9cfe-bcb8a05a845c"
                }
            ],
            "vip_port_id": "434ac600-b779-4428-b7a7-830e047511f1",
            "operating_status": "ONLINE",
            "vip_address": "192.168.0.181",
            "vip_subnet_id": "9a303536-417c-45dc-a6db-1234b9e1c2b2",
            "provider": "vlb",
            "tags": [],
            "name": "elb-ftci"

        }
    ]
}