ListLoadBalancers - Server Load Balancer - Centro de documentación de Alibaba Cloud

Enumera las instancias de Gateway Load Balancer (GWLB).

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

gwlb:ListLoadBalancers

list

LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/*

LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ZoneIds	array	No	La lista de ID de zonas. Puede consultar hasta 20 ID de zonas a la vez.
	string	No	El ID de la zona.	cn-beijing-h
VpcIds	array	No	La lista de ID de nube privada virtual (VPC). Puede consultar hasta 20 ID de VPC a la vez.
	string	No	El ID de la VPC.	vpc-bp1xuejaht4o7yhh2****
AddressIpVersion	string	No	La versión del protocolo. Valor válido: Ipv4: IPv4. Valores válidos: IPv4 : IPv4 DualStack : Pila doble.	Ipv4
LoadBalancerStatus	string	No	El estado de la instancia GWLB. Valores válidos: Active: La instancia está en ejecución. Inactive: La instancia está detenida. En este estado, el listener de la instancia no reenvía tráfico. Provisioning: Se está creando la instancia. Configuring: Se está modificando la instancia.	Active
LoadBalancerBusinessStatus	string	No	El estado comercial de la instancia GWLB. Valores válidos: Normal: La instancia se ejecuta según lo esperado. FinancialLocked: La instancia está bloqueada debido a un pago vencido.	Normal
LoadBalancerNames	array	No	La lista de nombres de instancias GWLB. Puede consultar hasta 20 nombres de instancias a la vez.
	string	No	El nombre de la instancia GWLB.	testGwlbName
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-aek2htf5qsyrn****
LoadBalancerIds	array	No	La lista de ID de instancias GWLB. Puede consultar hasta 20 ID de instancias a la vez.
	string	No	El ID de la instancia GWLB.	gwlb-cp6prgqy40hols****
TrafficMode	string	No	El modo de tráfico. Valores válidos: LoadBalance: La instancia está en modo de balanceo de carga. ByPass: La instancia está en modo de bypass.	LoadBalance
Tag	array<object>	No	La lista de etiquetas. Puede especificar hasta 20 etiquetas en cada llamada.
	object	No	El objeto de etiqueta.
Key	string	No	La clave de la etiqueta. La clave de la etiqueta no puede ser una cadena vacía. La clave de la etiqueta puede tener hasta 128 caracteres de longitud y no puede comenzar con `aliyun` o `acs:`. No puede contener `http://` o `https://`.	testTagKey
Value	string	No	El valor de la etiqueta. El valor de la etiqueta puede tener hasta 256 caracteres de longitud y no puede contener `http://` o `https://`.	testTagValue
NextToken	string	No	El token que se utiliza para la siguiente consulta. Valores válidos: Si NextToken está vacío, indica que no se debe enviar ninguna consulta posterior. Si NextToken tiene un valor, dicho valor es el token que se utiliza para la siguiente consulta.	WyJyb290IiwibiIsIm4iLDEsMCwxNjg1MDY1NTgyNzYwLCI2NDcwMGY2ZTc2Zjc0MWFiZGEyZjQyNzc4ZDk2MmJkOTk3ZGZmM2Nm****
MaxResults	integer	No	El número de entradas que se devolverán en cada página. Valores válidos: de 1 a 1000. Valor predeterminado: 20.	20
Skip	integer	No	El número de entradas que se deben omitir.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
LoadBalancers	array<object>	La lista de instancias GWLB.
	array<object>	La instancia GWLB.
AddressIpVersion	string	La versión del protocolo. Valor válido: IPv4: IPv4.	IPv4
CreateTime	string	La hora en que se creó el recurso. La hora se muestra en formato UTC y sigue el formato yyyy-MM-ddTHH:mm:ssZ.	2024-08-05T18:24:07Z
LoadBalancerBusinessStatus	string	El estado comercial de la instancia GWLB. Valores válidos: Normal: La instancia se ejecuta según lo esperado. FinancialLocked: La instancia está bloqueada debido a un pago vencido.	Normal
LoadBalancerId	string	El ID de la instancia GWLB.	gwlb-9njtjmqt7zfcqm****
LoadBalancerName	string	El nombre de la instancia GWLB. El nombre debe tener entre 2 y 128 caracteres de longitud, comenzar con una letra o un carácter chino, y puede contener dígitos, puntos (.), guiones bajos (_) y guiones (-).	testGwlbName
LoadBalancerStatus	string	El estado de la instancia GWLB. Valores válidos: Active: La instancia está en ejecución. Inactive: La instancia está detenida. En este estado, el listener de la instancia no reenvía tráfico. Provisioning: Se está creando la instancia. Configuring: Se está modificando la instancia.	Active
ResourceGroupId	string	El ID del grupo de recursos.	rg-aek26jasguy****
Tags	array<object>	La lista de etiquetas.
	object	La etiqueta.
Key	string	La clave de la etiqueta. La clave de la etiqueta no puede ser una cadena vacía. La clave de la etiqueta puede tener hasta 128 caracteres de longitud y no puede comenzar con `aliyun` o `acs:`. No puede contener `http://` o `https://`.	testTagKey
Value	string	El valor de la etiqueta. Puede especificar hasta 20 valores de etiqueta. El valor de la etiqueta puede ser una cadena vacía. El valor de la etiqueta puede tener hasta 128 caracteres de longitud, debe comenzar con una letra o un carácter chino, y puede contener dígitos, puntos (.), guiones bajos (_) y guiones (-). El valor de la etiqueta no puede comenzar con `aliyun` o `acs:`, y no puede contener `http://` o `https://`.	testTagValue
VpcId	string	El ID de la VPC.	vpc-uf6eg0vndlsa84n7r****
ZoneMappings	array<object>	La lista de asignaciones entre zonas y vSwitches. Debe agregar al menos una zona y puede agregar hasta 20 zonas. Si la región actual admite dos o más zonas, se recomienda que agregue dos o más zonas.
	array<object>	La asignación entre una zona y un vSwitch.
LoadBalancerAddresses	array<object>	La lista de direcciones de la instancia GWLB.
	object	La dirección de la instancia GWLB.
EniId	string	El ID de la interfaz de red elástica (ENI).	eni-bp17qv9zbzyqy629****
PrivateIpv4Address	string	La dirección IPv4 privada.	192.168.XX.XX
VSwitchId	string	El vSwitch en la zona. Cada zona utiliza un vSwitch y una subred de forma predeterminada.	vsw-2zemule5dz7okwqfv****
ZoneId	string	El ID de la zona. Puede llamar a la operación DescribeZones para consultar la lista de zonas más reciente.	cn-hangzhou-g
MaxResults	integer	El número de entradas devueltas en cada página. Valores válidos: de 1 a 1000. Valor predeterminado: 20.	20
NextToken	string	El token que se utiliza para la siguiente consulta. Valores válidos: No necesita especificar este parámetro para la primera solicitud o si no se va a enviar ninguna solicitud posterior. Si se va a enviar una consulta posterior, establezca el valor en el valor `NextToken` devuelto por la llamada a la API anterior.	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****
RequestId	string	El ID de la solicitud.	378A80E9-4262-5D8E-8D62-0969E52D7358
TotalCount	integer	El número total de entradas devueltas.	100

Ejemplos

Respuesta exitosa

JSON Formato

{
  "LoadBalancers": [
    {
      "AddressIpVersion": "IPv4",
      "CreateTime": "2024-08-05T18:24:07Z",
      "LoadBalancerBusinessStatus": "Normal",
      "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
      "LoadBalancerName": "testGwlbName",
      "LoadBalancerStatus": "Active",
      "ResourceGroupId": "rg-aek26jasguy****",
      "Tags": [
        {
          "Key": "testTagKey",
          "Value": "testTagValue"
        }
      ],
      "VpcId": "vpc-uf6eg0vndlsa84n7r****",
      "ZoneMappings": [
        {
          "LoadBalancerAddresses": [
            {
              "EniId": "eni-bp17qv9zbzyqy629****",
              "PrivateIpv4Address": "192.168.XX.XX"
            }
          ],
          "VSwitchId": "vsw-2zemule5dz7okwqfv****",
          "ZoneId": "cn-hangzhou-g"
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****",
  "RequestId": "378A80E9-4262-5D8E-8D62-0969E52D7358",
  "TotalCount": 100
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.