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
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Especifica el ID del proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
marker |
No |
String |
Especifica el identificador del último registro de la página anterior. Nota:
|
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:
Nota:
|
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:
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.
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.
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:
|
Parámetros 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
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. |
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. |
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:
Nota:
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.
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.
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:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID del equilibrador de carga. |
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:
|
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.
|
Parámetro |
Tipo |
Descripción |
---|---|---|
enable |
Boolean |
Especifica si se habilitará 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" }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Solicitud exitosa. |
Códigos de error
Consulte Códigos de error.