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 del balanceador de carga dedicado> Grupo de servidores de backend> Consulta de grupos de servidores backend

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

Ver PDF

Consulta de grupos de servidores backend

Función

Esta API se utiliza para consultar todos los grupos de servidores backend.

Restricciones

Esta API tiene las siguientes 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 /v3/{project_id}/elb/pools

**Tabla 1** Parámetros de path
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	Especifica el ID del proyecto.

**Tabla 2** Parámetros de Query
Parámetro	Obligatorio	Tipo	Descripción
marker	No	String	Especifica el identificador del último registro de la página anterior. Nota: Este parámetro debe usarse junto con limit. Si no se especifica este parámetro, se consultará la primera página. Este parámetro no se puede dejar en blanco ni establecer un ID no válido.
limit	No	Integer	Especifica el número de registros de cada página. Mínimo: 0 Máximo: 2000 Predeterminado: 2000
page_reverse	No	Boolean	Especifica si se va a utilizar la consulta inversa. Valores: true: consulta la página anterior. false (predeterminado): consulta la página siguiente. Nota: Este parámetro debe usarse junto con limit. Si page_reverse se establece en true y desea consultar la página anterior, establezca el valor de marker en el valor de previous_marker.
description	No	Array	Proporciona información adicional sobre el grupo de servidores backend. Se pueden consultar varias descripciones en el formato de description=xxx&description=xxx.
admin_state_up	No	Boolean	Especifica el estado administrativo del grupo de servidores backend. Este parámetro no es compatible. Por favor, no lo use.
healthmonitor_id	No	Array	Especifica el ID de la comprobación de estado configurada para el grupo de servidores backend. Se pueden consultar varios ID en el formato de healthmonitor_id=xxx&healthmonitor_id=xxx.
id	No	Array	Especifica el ID del grupo de servidores backend. Se pueden consultar múltiples ID en el formato id=xxx&id=xxx.
name	No	Array	Especifica el nombre del grupo del servidor backend. Se pueden consultar varios nombres con el formato name=xxx&name=xxx.
loadbalancer_id	No	Array	Especifica el ID del equilibrador de carga al que está asociado el grupo de servidores backend. Se pueden consultar varios ID en el formato de loadbalancer_id=xxx&loadbalancer_id=xxx.
protocol	No	Array	Especifica el protocolo utilizado por el grupo de servidores backend para recibir solicitudes del equilibrador de carga. El valor puede ser TCP, UDP, HTTP, HTTPS, o QUIC. Se pueden consultar múltiples protocolos en el formato de protocol=xxx&protocol=xxx. El protocolo QUIC no se admite en la región eu-nl.
lb_algorithm	No	Array	Especifica el algoritmo de equilibrio de carga utilizado por el equilibrador de carga para enrutar las solicitudes a los servidores backend del grupo de servidores backend asociado. El valor puede ser uno de los siguientes: ROUND_ROBIN: petirrojo redondo ponderado LEAST_CONNECTIONS: conexiones mínimas ponderadas SOURCE_IP: hash IP de origen QUIC_CID: ID de conexión Se pueden consultar múltiples algoritmos en el formato de lb_algorithm=xxx&lb_algorithm=xxx. El protocolo QUIC no se admite en la región eu-nl.
enterprise_project_id	No	Array	Especifica el ID del proyecto de empresa. Si no se pasa este parámetro, se consultan los recursos del proyecto de empresa predeterminado y se realiza la autenticación en función del proyecto de empresa predeterminado. Si se pasa este parámetro, su valor puede ser el ID de un proyecto de empresa existente (se requieren recursos en el proyecto de empresa específico) o all_granted_eps (se consultan recursos en todos los proyectos de empresa). Se pueden consultar varios identificadores en el formato enterprise_project_id=xxx&enterprise_project_id=xxx. Este parámetro no es compatible. Por favor, no lo use.
ip_version	No	Array	Especifica la versión de la dirección IP admitida por el grupo de servidores backend. Se pueden consultar varias versiones en el formato ip_version=xxx&ip_version=xxx.
member_address	No	Array	Especifica la dirección IP privada enlazada al servidor backend. Este es un parámetro de consulta y no se incluirá en la respuesta. Se pueden consultar varias direcciones IP en el formato de member_address=xxx&member_address=xxx.
member_device_id	No	Array	Especifica el ID del servidor en la nube que sirve como servidor backend. Este parámetro solo se utiliza como condición de consulta y no se incluye en la respuesta. Se pueden consultar varios identificadores en el formato member_device_id=xxx&member_device_id=xxx.
member_deletion_protection_enable	No	Boolean	Especifica si se debe habilitar la protección de eliminación en los servidores backend. true: Habilitar la protección de eliminación. false: Deshabilitar la protección de eliminación. Todos los servidores backend serán consultados si no se pasa este parámetro. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use.
listener_id	No	Array	Especifica los ID de los agentes de escucha asociados, incluidos los agentes de escucha asociados mediante directivas de reenvío. Se pueden consultar varios ID en el formato listener_id=xxx&listener_id=xxx.
member_instance_id	No	Array	Especifica el ID del servidor backend. Este parámetro solo se utiliza como condición de consulta y no se incluye en la respuesta. Se pueden consultar varios ID con el formato member_instance_id=xxx&member_instance_id=xxx.
vpc_id	No	Array	Especifica el ID de la VPC donde funciona el grupo de servidores backend.
type	No	Array	Especifica el tipo del grupo de servidores backend. Valores: instance: Se puede agregar cualquier tipo de servidores backend. vpc_id es obligatorio. ip: Solo se pueden agregar servidores backend entre VPC. No se puede especificar vpc_id. "": Se puede agregar cualquier tipo de servidores backend.

Parámetros de solicitud

**Tabla 3** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Especifica el token utilizado para la autenticación IAM.

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
request_id	String	Especifica el ID de la solicitud. El valor se genera automáticamente.
page_info	PageInfo object	Muestra información de paginación.
pools	Array of Pool objects	Muestra los grupos de servidores backend.

**Tabla 5** PageInfo
Parámetro	Tipo	Descripción
previous_marker	String	Especifica el ID del primer registro del resultado de la consulta de paginación. Establezca este parámetro para consultar la página anterior.
next_marker	String	Especifica el ID del último registro del resultado de la consulta de paginación. Establezca este parámetro para consultar la página siguiente.
current_count	Integer	Especifica el número de registros.

**Tabla 6** Pool
Parámetro	Tipo	Descripción
admin_state_up	Boolean	Especifica el estado administrativo del grupo de servidores backend. El valor solo puede ser true. Este parámetro no es compatible. Por favor, no lo use.
description	String	Proporciona información adicional sobre el grupo de servidores backend.
healthmonitor_id	String	Especifica el ID de la comprobación de estado configurada para el grupo de servidores backend.
id	String	Especifica el ID de grupo del servidor backend.
lb_algorithm	String	Especifica el algoritmo de equilibrio de carga utilizado por el equilibrador de carga para enrutar las solicitudes a los servidores backend del grupo de servidores backend asociado. El valor puede ser uno de los siguientes: ROUND_ROBIN: petirrojo redondo ponderado LEAST_CONNECTIONS: conexiones mínimas ponderadas SOURCE_IP: hash IP de origen QUIC_CID: ID de conexión Nota: Si el valor es SOURCE_IP, el parámetro de weight no tendrá efecto para los servidores backend. QUIC_CID solo se admite cuando el protocolo del grupo de servidores backend es QUIC. El protocolo QUIC no se admite en la región eu-nl.
listeners	Array of ListenerRef objects	Especifica los identificadores de los listeners con los que está asociado el grupo de servidores backend.
loadbalancers	Array of LoadBalancerRef objects	Especifica los ID de los equilibradores de carga con los que está asociado el grupo de servidores backend.
members	Array of MemberRef objects	Especifica los ID de los servidores backend del grupo de servidores backend.
name	String	Especifica el nombre del grupo del servidor backend.
project_id	String	Especifica el ID del proyecto.
protocol	String	Especifica el protocolo utilizado por el grupo de servidores backend para recibir solicitudes. El valor puede ser TCP, UDP, HTTP, HTTPS, o QUIC. Si el protocolo del listener es UDP, el protocolo del grupo de servidores backend debe ser UDP. Si el protocolo del listener es TCP, el protocolo del grupo de servidores backend debe ser TCP. Si el protocolo del listener es HTTP, el protocolo del grupo de servidores backend debe ser HTTP. Si el protocolo del listener es HTTPS, el protocolo del grupo de servidores backend puede ser HTTP o HTTPS. Si el protocolo del listener es TERMINATED_HTTPS, el protocolo del grupo de servidores backend debe ser HTTP. El protocolo QUIC no se admite en la región eu-nl.
session_persistence	SessionPersistence object	Especifica la sesión adhesiva.
ip_version	String	Especifica la versión de la dirección IP admitida por el grupo de servidores backend. IPv6 no es compatible. Solo se devolverá v4.
slow_start	SlowStart object	Especifica los detalles de inicio lento. Después de habilitar el inicio lento, los nuevos servidores backend agregados al grupo de servidores backend se calientan y el número de solicitudes que pueden recibir aumenta linealmente durante la duración de inicio lento configurada. Este parámetro se puede utilizar cuando el protocolo del grupo de servidores backend es HTTP o HTTPS. Se devolverá un error si el protocolo no es HTTP o HTTPS. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use.
member_deletion_protection_enable	Boolean	Especifica si se habilitará la protección de eliminación. true: Habilitar la protección de eliminación. false: Deshabilitar la protección de eliminación. NOTA: Desactive la protección de eliminación de todos sus recursos antes de eliminar su cuenta. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use.
created_at	String	Especifica la hora a la que se creó un grupo de servidores backend. El formato es yyyy-MM-dd'T'HH:mm:ss'Z' (hora UTC). Este es un campo nuevo en esta versión, y no se devolverá para los recursos asociados con balanceadores de carga dedicados existentes y para los recursos asociados con balanceadores de carga compartidos existentes y nuevos.
updated_at	String	Especifica la hora a la que se actualizó un grupo de servidores backend. El formato es yyyy-MM-dd'T'HH:mm:ss'Z' (hora UTC). Este es un campo nuevo en esta versión, y no se devolverá para los recursos asociados con balanceadores de carga dedicados existentes y para los recursos asociados con balanceadores de carga compartidos existentes y nuevos.
vpc_id	String	Especifica el ID de la VPC donde funciona el grupo de servidores backend.
type	String	Especifica el tipo del grupo de servidores backend. Valores: instance: Se puede agregar cualquier tipo de servidores backend. vpc_id es obligatorio. ip: Solo se pueden agregar servidores backend entre VPC. No se puede especificar vpc_id. "": Se puede agregar cualquier tipo de servidores backend.

**Tabla 7** ListenerRef
Parámetro	Tipo	Descripción
id	String	Especifica el ID del listener.

**Tabla 8** LoadBalancerRef
Parámetro	Tipo	Descripción
id	String	Especifica el ID del equilibrador de carga.

**Tabla 9** MemberRef
Parámetro	Tipo	Descripción
id	String	Especifica el ID del servidor backend.

**Tabla 10** SessionPersistence
Parámetro	Tipo	Descripción
cookie_name	String	Especifica el nombre de la cookie. El valor puede contener solo letras, dígitos, guiones (-) guiones bajos (_), y puntos (.). Nota: Este parámetro solo tendrá efecto cuando type se establece en APP_COOKIE.
type	String	Especifica el tipo de sesión adhesiva. El valor puede ser SOURCE_IP, HTTP_COOKIE, o APP_COOKIE.Nota: Si el protocolo del grupo de servidores backend es TCP o UDP, solo SOURCE_IP tiene efecto. Para balanceadores de carga dedicados, si el protocolo del grupo de servidores backend es HTTP o HTTPS, el valor solo puede ser HTTP_COOKIE.
persistence_timeout	Integer	Especifica la duración de la pegajosidad, en minutos. Este parámetro no tendrá efecto cuando type se establezca en APP_COOKIE. Si el protocolo del grupo de servidores backend es TCP, UDP o QUIC, el valor varía de 1 a 60, y el valor predeterminado es 1. Si el protocolo del grupo de servidores backend es HTTP o HTTPS, el valor varía de 1 a 1440, y el valor por defecto es 1440. El protocolo QUIC no se admite en la región eu-nl.

**Tabla 11** SlowStart
Parámetro	Tipo	Descripción
enable	Boolean	Especifica si se habilitará el inicio lento. true: Activar el inicio lento. false: Deshabilitar el inicio lento. Predeterminado: false
duration	Integer	Especifica la duración de inicio lento, en segundos. El valor oscila entre 30 y 1200, y el valor predeterminado es 30. Mínimo: 30 Máximo: 1200 Predeterminado: 30

Solicitudes de ejemplo

GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools?limit=2

Ejemplo de respuestas

Código de estado: 200

Solicitud exitosa.

{
  "pools" : [ {
    "lb_algorithm" : "ROUND_ROBIN",
    "protocol" : "HTTP",
    "type" : "",
    "vpc_id" : "",
    "description" : "",
    "admin_state_up" : true,
    "member_deletion_protection_enable" : false,
    "loadbalancers" : [ {
      "id" : "309a0f61-0b62-45f2-97d1-742f3434338e"
    } ],
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "session_persistence" : {
      "cookie_name" : "my_cookie",
      "type" : "APP_COOKIE",
      "persistence_timeout" : 1
    },
    "healthmonitor_id" : "",
    "listeners" : [ ],
    "members" : [ ],
    "id" : "73bd4fe0-ffbb-4b56-aab4-4f26ddf7a103",
    "name" : "",
    "ip_version" : "v4"
  }, {
    "lb_algorithm" : "SOURCE_IP",
    "protocol" : "TCP",
    "description" : "",
    "admin_state_up" : true,
    "member_deletion_protection_enable" : false,
    "loadbalancers" : [ {
      "id" : "d9763e59-64b7-4e93-aec7-0ff7881ef9bc"
    } ],
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "session_persistence" : {
      "cookie_name" : "",
      "type" : "SOURCE_IP",
      "persistence_timeout" : 1
    },
    "healthmonitor_id" : "",
    "listeners" : [ {
      "id" : "8d21db6f-b475-429e-a9cb-90439b0413b2"
    } ],
    "members" : [ ],
    "id" : "74db02d1-5711-4c77-b383-a450e2b93142",
    "name" : "pool_tcp_001",
    "ip_version" : "dualstack"
  } ],
  "page_info" : {
    "next_marker" : "74db02d1-5711-4c77-b383-a450e2b93142",
    "previous_marker" : "73bd4fe0-ffbb-4b56-aab4-4f26ddf7a103",
    "current_count" : 2
  },
  "request_id" : "a1a7e852-1928-48f7-bbc9-ca8469898713"
}