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.
Actualización más reciente 2022-11-17 GMT+08:00

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.

URI

GET /v2/{project_id}/elb/loadbalancers

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

String

Especifica el ID del proyecto.

Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

marker

No

String

Especifica el ID del oyente desde el que se inicia la consulta de paginación, es decir, el ID del último oyente de la página anterior.

Este parámetro debe usarse junto con limit.

limit

No

Integer

Especifica el número de oyentes en cada página. Si este parámetro no está definido, todos los balanceadores de carga se consultan de forma predeterminada.

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.

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

Especifica el estado administrativo del balanceador de carga.

Este parámetro está reservado y el valor predeterminado es true.

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 reside el balanceador de carga.

enterprise_project_id

No

String

Especifica el ID del proyecto de empresa.

  • Si no se pasa enterprise_project_id, los recursos de todos los proyectos de empresa se consultan de forma predeterminada. Se realiza una autorización de grano fino. Los permisos elb:loadbalancers:list deben asignarse al grupo de usuarios.
  • Si se pasa enterprise_project_id, el valor puede ser un ID de proyecto de empresa específico o all_granted_eps. Si el valor es un ID de proyecto de empresa específico, sólo se consultan los recursos del proyecto de empresa. Si el valor es all_granted_eps, se consultan los recursos de los proyectos de empresa con los permisos elb:loadbalancers:list.

Solicitud

No hay

Respuesta

Tabla 3 Parámetros de respuesta

Parámetro

Tipo

Descripción

loadbalancers

Array of Loadbalancers objects

Enumera los balanceadores de carga. Para más detalles, consulte Tabla 4.

Tabla 4 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 en el que se utiliza el balanceador de carga.

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.

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 of Listeners objects

Muestra los ID de oyentes agregados al balanceador de carga. Para más detalles, consulte Tabla 6.

pools

Array of Pools objects

Muestra los ID de los grupos de servidores backend asociados con el balanceador de carga. Para más detalles, consulte Tabla 7.

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.

enterprise_project_id

String

Especifica el ID del proyecto de empresa. Al crear un balanceador de carga, puede asignar un proyecto de empresa al balanceador de carga.

El valor es una string de caracteres 0 o un UUID con guiones (-). El valor 0 indica el proyecto de empresa predeterminado.

NOTA:

Para obtener más información acerca de los proyectos de empresa y cómo obtener los ID de proyecto de empresa, consulte Guía del usuario de Enterprise Management.

Tabla 5 Descripción del parámetro listeners

Parámetro

Tipo

Descripción

id

String

Especifica el ID del oyente asociado.

Tabla 6 Descripción del parámetro pools

Parámetro

Tipo

Descripción

id

String

Especifica el ID del grupo de servidores backend asociado.

Ejemplo de la solicitud

  • Ejemplo de solicitud 1
    GET https://{Endpoint}/v2/1a3e005cf9ce40308c900bcb08e5320c/elb/loadbalancers
  • Ejemplo de solicitud 2
    GET https://{Endpoint}/v2/1a3e005cf9ce40308c900bcb08e5320c/elb/loadbalancers?limit=10&marker=165b6a38-5278-4569-b747-b2ee65ea84a4
  • Ejemplo de solicitud 3
    GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/loadbalancers?member_address=192.168.0.198

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",
                "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" 
            }
    ]
    }
  • 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",
                "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" 
            }
        ]
    
    }
  • Ejemplo de respuesta 3
    {
        "loadbalancers": [
            {
                "description": "",
                "provisioning_status": "ACTIVE",
                "tenant_id": "601240b9c5c94059b63d484c92cfe308",
                "project_id": "601240b9c5c94059b63d484c92cfe308",
                "admin_state_up": true,
                "provider": "vlb",
                "pools": [
                    {
                        "id": "ed75f16e-fcc6-403e-a3fb-4eae82005eab"
                    },
                    {
                        "id": "f15f2723-4135-4bf8-9259-047d92684197"
                    }
                ],
                "listeners": [
                    {
                        "id": "75045172-70e9-480d-9443-b8b6459948f7"
                    },
                    {
                        "id": "b9a99cbb-d0a1-4269-bc5f-752ec37a10c3"
                    }
                ],
                "vip_port_id": "fb3f10f0-9417-4cf2-a82e-8f1da1687484",
                "operating_status": "ONLINE",
                "vip_address": "192.168.0.16",
                "vip_subnet_id": "3a450aa4-f642-4da8-b70d-cafd4a633b51",
                "id": "bc7ba445-035a-4464-a1a3-a62cf4a14116",
                "tags": [],
                "name": "elb-hm-test",
                "created_at": "2018-07-25T01:54:13", 
                "updated_at": "2018-07-25T01:54:14",  
                "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2"                
            }
        ]
    }

Código de estado

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