Viewing Details of a Load Balancer
Function
This API is used to view details of a load balancer.
URI
GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Especifica el ID del proyecto. |
loadbalancer_id |
Sí |
String |
Especifica el ID del equilibrador de carga. |
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. |
loadbalancer |
LoadBalancer object |
Especifica el equilibrador de carga. |
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 |
Solicitudes de ejemplo
Ver detalles de un equilibrador de carga
GET https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers/3dbde7e5-c277-4ea3-a424-edd339357eff
Ejemplo de respuestas
Código de estado: 200
Solicitud exitosa.
{ "loadbalancer" : { "id" : "3dbde7e5-c277-4ea3-a424-edd339357eff", "project_id" : "060576782980d5762f9ec014dd2f1148", "name" : "elb-l4-no-delete", "description" : null, "vip_port_id" : "f079c7ee-65a9-44ef-be86-53d8927e59be", "vip_address" : "10.0.0.196", "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ ], "pools" : [ { "id" : "1d864dc9-f6ef-4366-b59d-7034cde2328f" }, { "id" : "c0a2e4a1-c028-4a24-a62f-e721c52f5513" }, { "id" : "79308896-6169-4c28-acbc-e139eb661996" } ], "tags" : [ ], "provider" : null, "created_at" : "2019-12-02T09:55:11Z", "updated_at" : "2019-12-02T09:55:11Z", "vpc_id" : "70711260-9de9-4d96-9839-0ae698e00109", "enterprise_project_id" : "0", "availability_zone_list" : [ ], "ipv6_vip_address" : null, "ipv6_vip_virsubnet_id" : null, "ipv6_vip_port_id" : null, "publicips" : [ ], "elb_virsubnet_ids" : [ "ad5d63bf-3b50-4e88-b4d9-e94a59aade48" ], "eips" : [ ], "guaranteed" : true, "billing_info" : null, "l4_flavor_id" : "e5acacda-f861-404e-9871-df480c49d185", "l4_scale_flavor_id" : null, "l7_flavor_id" : null, "l7_scale_flavor_id" : null, "vip_subnet_cidr_id" : "396d918a-756e-4163-8450-3bdc860109cf", "deletion_protection_enable" : false, "autoscaling" : { "enable" : true, "min_l7_flavor_id" : "0c8cf29d-51cb-4c1d-8e25-1c61cf5c2b00" }, "public_border_group" : "center" }, "request_id" : "1a47cfbf-969f-4e40-8c0e-c2e60b14bcac" }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Solicitud exitosa. |
Códigos de error
Consulte Códigos de error.