Consulta de balanceadores de carga
Función
Esta API se utiliza para consultar todos los balanceadores de carga.
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/loadbalancers
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Este parámetro tiene el mismo significado que eips. Mínimo: 1 Máximo: 255 |
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:
|
id |
No |
Array |
Especifica el ID del equilibrador de carga. Se pueden consultar múltiples ID en el formato id=xxx&id=xxx. |
name |
No |
Array |
Especifica el nombre del equilibrador de carga. Se pueden consultar varios nombres con el formato name=xxx&name=xxx. |
description |
No |
Array |
Proporciona información adicional sobre el equilibrador de carga. Se pueden consultar varias descripciones en el formato de description=xxx&description=xxx. |
admin_state_up |
No |
Boolean |
Especifica el estado administrativo del equilibrador de carga. Este parámetro no es compatible. Por favor, no lo use. |
provisioning_status |
No |
Array |
Especifica el estado de aprovisionamiento del equilibrador de carga.
Se pueden consultar varios estados de aprovisionamiento en el formato de provisioning_status=xxx&provisioning_status=xxx. |
operating_status |
No |
Array |
Especifica el estado de funcionamiento del equilibrador de carga.
Se pueden consultar varios estados operativos en el formato de operating_status=xxx&operating_status=xxx. |
guaranteed |
No |
Boolean |
Especifica si el equilibrador de carga es un equilibrador de carga dedicado.
|
vpc_id |
No |
Array |
Especifica el ID de la VPC donde reside el equilibrador de carga. Se pueden consultar varios ID en el formato de vpc_id=xxx&vpc_id=xxx. |
vip_port_id |
No |
Array |
Especifica el ID del puerto enlazado a la dirección IPv4 privada del equilibrador de carga. Se pueden consultar varios ID en el formato de vip_port_id=xxx&vip_port_id=xxx. |
vip_address |
No |
Array |
Especifica la dirección IP virtual enlazada al equilibrador de carga. Se pueden consultar varias direcciones IP virtuales en el formato vip_address=xxx&vip_address=xxx. |
vip_subnet_cidr_id |
No |
Array |
Especifica el ID de la subred IPv4 donde reside el equilibrador de carga. Se pueden consultar múltiples ID en el formato de vip_subnet_cidr_id=xxx&vip_subnet_cidr_id=xxx. |
ipv6_vip_port_id |
No |
Array |
Especifica el ID del puerto enlazado a la dirección IPv6 del equilibrador de carga. Se pueden consultar varios puertos en el formato ipv6_vip_port_id=xxx&ipv6_vip_port_id=xxx. IPv6 no es compatible. Por favor, no utilice este parámetro. |
ipv6_vip_address |
No |
Array |
Especifica la dirección IPv6 enlazada al equilibrador de carga. Se pueden consultar varias direcciones IPv6 en el formato ipv6_vip_address=xxx&ipv6_vip_address=xxx. IPv6 no es compatible. Por favor, no utilice este parámetro. |
ipv6_vip_virsubnet_id |
No |
Array |
Especifica el ID de la subred IPv6 donde reside el equilibrador de carga. Se pueden consultar varios ID en el formato de ipv6_vip_virsubnet_id=xxx&ipv6_vip_virsubnet_id=xxx. IPv6 no es compatible. Por favor, no utilice este parámetro. |
eips |
No |
Array |
Especifica el EIP IPv4 enlazado al equilibrador de carga. El siguiente es un ejemplo: "eips": [ { "eip_id": "e9b72a9d-4275-455e-a724-853504e4d9c6", "eip_address": "88.88.14.122", "ip_version": 4 } ] Se pueden consultar múltiples EIP.
Tenga en cuenta que este parámetro tiene el mismo significado que publicips. |
publicips |
No |
Array |
Especifica el EIP IPv4 enlazado al equilibrador de carga. El siguiente es un ejemplo: "publicips": [ { "publicip_id": "e9b72a9d-4275-455e-a724-853504e4d9c6", "publicip_address": "88.88.14.122", "ip_version": 4 } ] Se pueden consultar múltiples EIP.
Tenga en cuenta que este parámetro tiene el mismo significado que eips. |
availability_zone_list |
No |
Array |
Especifica la lista de Zonas de disponibilidad donde se crea el equilibrador de carga. Se pueden consultar varias zonas de disponibilidad en el formato de availability_zone_list=xxx&availability_zone_list=xxx. |
l4_flavor_id |
No |
Array |
Especifica el ID de un variante en la capa 4. Se pueden consultar varios ID en el formato de l4_flavor_id=xxx&l4_flavor_id=xxx. |
l4_scale_flavor_id |
No |
Array |
Especifica el ID del variante elástico en la capa 4, que está reservado por ahora. Se pueden consultar varios sabores en el formato de l4_scale_flavor_id=xxx&l4_scale_flavor_id=xxx. Este parámetro no es compatible. Por favor, no lo use. |
l7_flavor_id |
No |
Array |
Especifica el ID de un variante en la capa 7. Se pueden consultar varios sabores en el formato de l7_flavor_id=xxx&l7_flavor_id=xxx. |
l7_scale_flavor_id |
No |
Array |
Especifica el ID del variante elástico en la capa 7. Se pueden consultar varios sabores en el formato de l7_scale_flavor_id=xxx&l7_scale_flavor_id=xxx. Este parámetro no es compatible. Por favor, no lo use. |
billing_info |
No |
Array |
Proporciona información de facturación de recursos. Se pueden consultar varios valores en el formato de billing_info=xxx&billing_info=xxx. Este parámetro no es compatible. Por favor, no lo use. |
member_device_id |
No |
Array |
Especifica el ID del servidor en la nube asociado al equilibrador de carga como servidor backend. Este es un parámetro de consulta y no se incluirá en la respuesta. Se pueden consultar varios identificadores en el formato member_device_id=xxx&member_device_id=xxx. |
member_address |
No |
Array |
Especifica la dirección IP privada del servidor en la nube asociado al equilibrador de carga como servidor backend. Este es un parámetro de consulta y no se incluirá en la respuesta. Se pueden consultar varias direcciones IP privadas en el formato member_address=xxx&member_address=xxx. |
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 IP. El valor puede ser 4 (IPv4) o 6 (IPv6). Se pueden consultar varias versiones en el formato ip_version=xxx&ip_version=xxx. IPv6 no es compatible. El valor no puede ser 6. |
deletion_protection_enable |
No |
Boolean |
Especifica si se habilitará la protección de eliminación.
Este parámetro no está disponible en la región eu-nl. Por favor, no lo use. |
elb_virsubnet_type |
No |
Array |
Especifica el tipo de subred en el plano descendente.
Se pueden consultar varios valores en el formato de elb_virsubnet_type=ipv4&elb_virsubnet_type=dualstack. |
autoscaling |
No |
Array |
Especifica si se activa la escala elástica. Ejemplo: "autoscaling": { "enable": "true" } Se pueden consultar varios valores en el formato de autoscaling=enable=true&autoscaling=enable=false. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
No |
String |
Especifica el token utilizado para la autenticación IAM. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
loadbalancers |
Array of LoadBalancer objects |
Enumera los equilibradores de carga. |
page_info |
PageInfo object |
Muestra información de paginación sobre balanceadores de carga. |
request_id |
String |
Especifica el ID de la solicitud. El valor se genera automáticamente. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID del equilibrador de carga. |
description |
String |
Proporciona información adicional sobre el equilibrador de carga. Mínimo: 1 Máximo: 255 |
provisioning_status |
String |
Especifica el estado de aprovisionamiento del equilibrador de carga. El valor puede ser uno de los siguientes:
|
admin_state_up |
Boolean |
Especifica el estado administrativo del equilibrador de carga. El valor solo puede ser true. |
provider |
String |
Especifica el proveedor del equilibrador de carga. El valor solo puede ser vlb. |
pools |
Array of PoolRef objects |
Muestra los ID de los grupos de servidores backend asociados con el equilibrador de carga. |
listeners |
Array of ListenerRef objects |
Muestra los ID de los oyentes agregados al balanceador de carga. |
operating_status |
String |
Especifica el estado de funcionamiento del equilibrador de carga. El valor solo puede ser ONLINE, lo que indica que el balanceador de carga se está ejecutando normalmente. |
name |
String |
Especifica el nombre del equilibrador de carga. |
project_id |
String |
Especifica el ID del proyecto del equilibrador de carga. |
vip_subnet_cidr_id |
String |
Especifica el ID de la subred IPv4 donde reside el equilibrador de carga. |
vip_address |
String |
Especifica la dirección IPv4 privada enlazada al equilibrador de carga. |
vip_port_id |
String |
Especifica el ID del puerto enlazado a la dirección IPv4 privada del equilibrador de carga. Cuando se crea un equilibrador 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. |
tags |
Array of Tag objects |
Muestra las etiquetas agregadas al balanceador de carga. |
created_at |
String |
Especifica la hora en que se creó el equilibrador de carga, con el formato aaaa-MM-dd'T''HH:mm:ss''Z''. |
updated_at |
String |
Especifica la hora en que se actualizó el equilibrador de carga, con el formato aaaa-MM-dd'T''HH:mm:ss''Z''. |
guaranteed |
Boolean |
Especifica si el equilibrador de carga es un equilibrador de carga dedicado.
|
vpc_id |
String |
Especifica el ID de la VPC donde reside el equilibrador de carga. |
eips |
Array of EipInfo objects |
Especifica el EIP enlazado al equilibrador de carga. Solo se puede vincular un EIP a un equilibrador de carga. Este parámetro tiene el mismo significado que publicips. |
ipv6_vip_address |
String |
Especifica la dirección IPv6 enlazada al equilibrador de carga. IPv6 no es compatible. Por favor, no utilice este parámetro. |
ipv6_vip_virsubnet_id |
String |
Especifica el ID de la subred IPv6 donde reside el equilibrador de carga. IPv6 no es compatible. Por favor, no utilice este parámetro. |
ipv6_vip_port_id |
String |
Especifica el ID del puerto enlazado a la dirección IPv6 del equilibrador de carga. IPv6 no es compatible. Por favor, no utilice este parámetro. |
availability_zone_list |
Array of strings |
Especifica la lista de Zonas de disponibilidad donde se crea el equilibrador de carga. |
enterprise_project_id |
String |
Especifica el ID del proyecto de empresa. Si este parámetro no se pasa durante la creación de recursos, se devolverá "0" y el recurso pertenece al proyecto de empresa predeterminado. "0" no es un ID de proyecto empresarial válido y no se puede usar en las API para crear, actualizar el balanceador de carga o consultar detalles del balanceador de carga. Este parámetro no es compatible. Por favor, no lo use. |
billing_info |
String |
Proporciona información de facturación de recursos.
Este parámetro no es compatible. Por favor, no lo use. Mínimo: 1 Máximo: 1024 |
l4_flavor_id |
String |
Especifica el ID de un variante en la capa 4. Mínimo: 1 Máximo: 255 |
l4_scale_flavor_id |
String |
Especifica el ID del variante reservado en la capa 4. Este parámetro no es compatible. Por favor, no lo use. Mínimo: 1 Máximo: 255 |
l7_flavor_id |
String |
Especifica el ID de un variante en la capa 7. Mínimo: 1 Máximo: 255 |
l7_scale_flavor_id |
String |
Especifica el ID del variante reservado en la capa 7. Este parámetro no es compatible. Por favor, no lo use. Mínimo: 1 Máximo: 255 |
publicips |
Array of PublicIpInfo objects |
Especifica el EIP enlazado al equilibrador de carga. Solo se puede vincular un EIP a un equilibrador de carga. Este parámetro tiene el mismo significado que eips. |
global_eips |
Array of GlobalEipInfo objects |
Especifica el ID del EIP global enlazado al equilibrador de carga. Solo se enlazará el primer EIP global especificado en iglobal_eips. Este parámetro no es compatible. Por favor, no lo use. |
elb_virsubnet_ids |
Array of strings |
Muestra los identificadores de las subredes en el plano descendente. |
elb_virsubnet_type |
String |
Especifica el tipo de subred en el plano descendente.
|
ip_target_enable |
Boolean |
Especifica si se habilitará el backend entre VPC. Si habilita esta función, puede agregar servidores en una VPC conectada a través de una conexión de pares de VPC, en una VPC conectada a través de una conexión en la nube o en un centro de datos local en el otro extremo de una conexión Direct Connect o VPN, mediante el uso de sus direcciones IP. Esta función solo es compatible con balanceadores de carga dedicados. El valor puede ser true (habilitar backend cruzado de VPC) o false (habilitar backend cruzado de VPC). El valor solo se puede actualizar a true. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use. |
frozen_scene |
String |
Especifica el escenario en el que el equilibrador de carga está congelado. Los valores múltiples se separan mediante comas.
Este parámetro no es compatible. Por favor, no lo use. |
ipv6_bandwidth |
BandwidthRef object |
Especifica el identificador del ancho de banda utilizado por una dirección IPv6. Este parámetro sólo está disponible cuando se crea o actualiza un equilibrador de carga con una dirección IPv6 pública. Si utiliza una nueva dirección IPv6 y especifica un ancho de banda compartido, la dirección IPv6 se agregará al ancho de banda compartido. IPv6 no es compatible. Por favor, no utilice este parámetro. |
deletion_protection_enable |
Boolean |
Especifica si está habilitada la protección de eliminación.
NOTA:
Desactive la protección de eliminación de todos tus recursos antes de eliminar su cuenta. Este parámetro solo se devuelve cuando la protección de eliminación está habilitada en el sitio. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use. |
autoscaling |
AutoscalingRef object |
Especifica información sobre la escala elástica. Si está habilitado el escalado elástico, las especificaciones del balanceador de carga se pueden ajustar automáticamente en función del tráfico entrante. Nota:
|
public_border_group |
String |
Especifica el grupo zona de disponibilidad al que pertenece el equilibrador de carga. |
waf_failure_action |
String |
Especifica las directivas de distribución de tráfico cuando el WAF es defectuoso. discard: el tráfico no se distribuirá. forward (predeterminado): El tráfico se distribuirá a los servidores backend. Nota: Este parámetro solo tiene efecto cuando WAF está habilitado para el balanceador de carga. Este parámetro no es compatible. Por favor, no lo use. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID del grupo de servidores backend. |
Parámetro |
Tipo |
Descripción |
---|---|---|
key |
String |
Especifica la clave de etiqueta. Mínimo: 1 Máximo: 36 |
value |
String |
Especifica el valor de etiqueta. Mínimo: 0 Máximo: 43 |
Parámetro |
Tipo |
Descripción |
---|---|---|
eip_id |
String |
eip_id |
eip_address |
String |
eip_address |
ip_version |
Integer |
Especifica la versión IP. 4 indica IPv4 y 6 indica IPv6. IPv6 no es compatible. El valor no puede ser 6. |
Parámetro |
Tipo |
Descripción |
---|---|---|
publicip_id |
String |
Especifica el ID de EIP. |
publicip_address |
String |
Especifica la dirección IP. |
ip_version |
Integer |
Especifica la versión IP. El valor puede ser 4 (IPv4) o 6 (IPv6). IPv6 no es compatible. El valor no puede ser 6. |
Parámetro |
Tipo |
Descripción |
---|---|---|
global_eip_id |
String |
Especifica el ID del EIP global. |
global_eip_address |
String |
Especifica el EIP global. |
ip_version |
Integer |
Especifica la versión IP. El valor puede ser 4 y 6. 4 indica una dirección IPv4, y 6 indica una dirección IPv6. [IPv6 no es compatible. No establezca este parámetro en 6.] |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID de ancho de banda compartido. |
Parámetro |
Tipo |
Descripción |
---|---|---|
enable |
Boolean |
Especifica si se activa la escala elástica para el equilibrador de carga.
Predeterminado: false |
min_l7_flavor_id |
String |
Especifica el ID del tipo mínimo de capa 7 para la escala elástica. Este parámetro no se puede dejar en blanco si hay oyentes HTTP o HTTPS. Mínimo: 1 Máximo: 36 |
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. |
Solicitudes de ejemplo
- Consulta de balanceadores de carga en cada página
GET https://{ELB_Endpoint}/v3/b2782e6708b8475c993e6064bc456bf8/elb/loadbalancers?id=87627cb6-9ff1-4580-984f-cc564fa9fc34&id=09e86f09-03fc-440e-8132-03f3e149e979
- Consulta de balanceadores de carga con varios ID
GET https://{ELB_Endpoint}/v3/b2782e6708b8475c993e6064bc456bf8/elb/loadbalancers?limit=2&marker=87627cb6-9ff1-4580-984f-cc564fa9fc34
Ejemplo de respuestas
Código de estado: 200
Solicitud exitosa.
{ "request_id" : "46b7d911-cece-408c-a2cc-55c78ab025d8", "loadbalancers" : [ { "id" : "65672f7e-2024-4c39-9198-98249da479c5", "project_id" : "057ef081eb00d2732fd1c01a9be75e6f", "name" : "dxq_2021_07_26_11_12_37", "description" : "", "vip_port_id" : "b289f890-a6fa-4405-a9cc-fe62b8a3bed0", "vip_address" : "172.16.0.152", "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ { "id" : "dc9572eb-a5b2-47b3-a982-44892d833892" } ], "pools" : [ { "id" : "dc6b01c4-f704-4427-a4c2-21cd5f58d177" } ], "tags" : [ ], "provider" : "vlb", "created_at" : "2021-07-26T03:12:37Z", "updated_at" : "2021-07-26T03:12:37Z", "vpc_id" : "6e0ee31f-7a46-4530-b32f-ce41f30959d4", "enterprise_project_id" : "0", "availability_zone_list" : [ "az1" ], "ipv6_vip_address" : "2001:db8:a583:4cb:d6b8:f8b4:4211:fe72", "ipv6_vip_virsubnet_id" : "0b9e3c5e-3ec8-46b3-bab9-80b1450e59ee", "ipv6_vip_port_id" : "5186bb47-24e5-4171-b795-62d22846db9b", "publicips" : [ ], "elb_virsubnet_ids" : [ "0b9e3c5e-3ec8-46b3-bab9-80b1450e59ee" ], "elb_virsubnet_type" : "dualstack", "ip_target_enable" : false, "autoscaling" : { "enable" : false, "min_l7_flavor_id" : "" }, "frozen_scene" : null, "eips" : [ ], "guaranteed" : true, "billing_info" : null, "l4_flavor_id" : "aa06b26b-9ff9-43c6-92b9-41e0f746bca6", "l4_scale_flavor_id" : null, "l7_flavor_id" : "e2a5675c-a181-444e-b9a5-17b052dc7fb9", "l7_scale_flavor_id" : null, "vip_subnet_cidr_id" : "96e52038-7983-462f-8a96-415d8a280b13", "public_border_group" : "center" }, { "id" : "cce5318e-c79a-4f68-94a2-9fb285c6efbe", "project_id" : "057ef081eb00d2732fd1c01a9be75e6f", "name" : "elb-reset", "description" : "", "vip_port_id" : null, "vip_address" : null, "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ { "id" : "0ae21c37-8b90-4e73-8a35-eedde6d2538c" } ], "pools" : [ { "id" : "904ecca6-8ebb-4974-9c5c-61d1d66fba17" } ], "tags" : [ ], "provider" : "vlb", "created_at" : "2021-07-26T02:46:31Z", "updated_at" : "2021-07-26T02:46:59Z", "vpc_id" : "59cb11ef-f185-49ba-92af-0539e8ff9734", "enterprise_project_id" : "0", "availability_zone_list" : [ "az1" ], "ipv6_vip_address" : null, "ipv6_vip_virsubnet_id" : null, "ipv6_vip_port_id" : null, "publicips" : [ { "publicip_id" : "0c07e04d-e2f9-41ad-b934-f58a65b6734d", "publicip_address" : "97.97.2.171", "ip_version" : 4 } ], "elb_virsubnet_ids" : [ "7f817f9c-8731-4002-9e47-18cb8d431787" ], "elb_virsubnet_type" : "dualstack", "ip_target_enable" : false, "autoscaling" : { "enable" : false, "min_l7_flavor_id" : "" }, "frozen_scene" : null, "eips" : [ { "eip_id" : "0c07e04d-e2f9-41ad-b934-f58a65b6734d", "eip_address" : "97.97.2.171", "ip_version" : 4 } ], "guaranteed" : true, "billing_info" : null, "l4_flavor_id" : "636ba721-935a-4ca5-a685-8076ce0e4148", "l4_scale_flavor_id" : null, "l7_flavor_id" : null, "l7_scale_flavor_id" : null, "vip_subnet_cidr_id" : null, "public_border_group" : "center" } ], "page_info" : { "next_marker" : "cce5318e-c79a-4f68-94a2-9fb285c6efbe", "previous_marker" : "65672f7e-2024-4c39-9198-98249da479c5", "current_count" : 2 } }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Solicitud exitosa. |
Códigos de error
Consulte Códigos de error.