Consulta de servidores backend
Función
Esta API se utiliza para consultar servidores backend en un grupo de servidores backend específico. 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/pools/{pool_id}/members
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
pool_id |
Sí |
String |
Especifica el ID del grupo de servidores backend. |
Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
marker |
No |
String |
Especifica el ID del servidor backend desde el que se inicia la consulta de paginación, es decir, el ID del último servidor backend de la página anterior. Si no se especifica este parámetro, se consultará la primera página. Este parámetro debe usarse junto con limit. |
limit |
No |
Integer |
Especifica el número de servidores backend de cada página. Si este parámetro no está definido, todos los servidores backend 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 servidor backend.
NOTA:
El valor de este parámetro no es el ID de servidor. Es el ID generado automáticamente para el servidor backend asociado con el balanceador de carga. |
tenant_id |
No |
String |
Especifica el ID del proyecto en el que se utiliza el servidor backend. El valor contiene un máximo de 255 caracteres. |
project_id |
No |
String |
Especifica el ID del proyecto al que pertenece el servidor backend. Este parámetro tiene el mismo significado que tenant_id. |
name |
No |
String |
Especifica el nombre del servidor backend. El valor contiene un máximo de 255 caracteres.
NOTA:
El valor de este parámetro no es el nombre de servidor. Es el nombre generado automáticamente para el servidor backend asociado con el balanceador de carga. |
address |
No |
String |
Especifica la dirección IP privada del servidor backend. El valor incluye un máximo de 64 caracteres. |
protocol_port |
No |
Integer |
Especifica el puerto utilizado por el servidor backend. |
subnet_id |
No |
String |
Especifica el ID de la subred donde funciona el servidor backend. |
admin_state_up |
No |
Boolean |
Especifica el estado administrativo del servidor backend. Este parámetro está reservado y el valor predeterminado es true. |
weight |
No |
Integer |
Especifica el peso del servidor backend. |
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
members |
Array |
Muestra los servidores backend del grupo de servidores backend. Para más detalles, consulte Tabla 4. |
members_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 5. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID del servidor backend.
NOTA:
El valor de este parámetro no es el ID de servidor. Es el ID generado automáticamente para el servidor backend asociado con el balanceador de carga. |
tenant_id |
String |
Especifica el ID del proyecto en el que se utiliza el servidor backend. El valor contiene un máximo de 255 caracteres. |
project_id |
String |
Especifica el ID del proyecto al que pertenece el servidor backend. Este parámetro tiene el mismo significado que tenant_id. |
name |
String |
Especifica el nombre del servidor backend. El valor contiene un máximo de 255 caracteres. |
address |
String |
Especifica la dirección IP privada del servidor backend. Esta dirección IP debe estar en la subred especificada por subnet_id. Este parámetro solo se puede establecer en la dirección IP de la NIC primaria, por ejemplo, 192.168.3.11. El valor incluye un máximo de 64 caracteres. |
protocol_port |
Integer |
Especifica el puerto utilizado por el servidor backend. El número de puerto se encuentra dentro del rango de 1 a 65535. |
subnet_id |
String |
Especifica el ID de la subred donde funciona el servidor backend. La dirección IP privada del servidor backend se encuentra en esta subred. No se admiten subredes IPv6. |
admin_state_up |
Boolean |
Especifica el estado administrativo del servidor backend. Este parámetro está reservado. El valor puede ser true o false.
|
weight |
Integer |
Especifica el peso del servidor backend. El valor varía de 0 a 100. Si el valor es 0, el servidor backend no aceptará nuevas solicitudes. El valor predeterminado es 1. |
operating_status |
String |
Especifica el estado de funcionamiento del balanceador de carga. Este parámetro está reservado, y su valor puede ser ONLINE o FROZEN. |
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.
|
Ejemplo de la solicitud
- Ejemplo de solicitud 1: consulta de todos los servidores backend
GET https://{Endpoint}/v2.0/lbaas/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members
- Ejemplo de solicitud 2: Consulta del servidor en la nube de backend cuya dirección IP es 10.0.0.8 y el número de puerto es 80
GET https://{Endpoint}/v2.0/lbaas/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members?address=10.0.0.8&protocol_port=80
Ejemplo de la respuesta
- Ejemplo de respuesta 1
{ "members": [ { "address": "10.0.0.8", "admin_state_up": true, "id": "9a7aff27-fd41-4ec1-ba4c-3eb92c629313", "protocol_port": 80, "subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2", "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c", "project_id": "1a3e005cf9ce40308c900bcb08e5320c", "weight": 1, "operating_status": "ONLINE", "name": "member-name" } ] }
- Ejemplo de respuesta 2
{ "members": [ { "address": "10.0.0.8", "admin_state_up": true, "id": "9a7aff27-fd41-4ec1-ba4c-3eb92c629313", "protocol_port": 80, "subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2", "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c", "project_id": "1a3e005cf9ce40308c900bcb08e5320c", "weight": 1, "operating_status": "ONLINE", "name": "member-name" } ] }
Código de estado
Para más detalles, consulte Códigos de estado.