ListLoadBalancers - Server Load Balancer: Central de Documentação do Alibaba Cloud

Lista as instâncias do Gateway Load Balancer (GWLB).

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

gwlb:ListLoadBalancers

list

LoadBalancer

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

LoadBalancer

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

VPC

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ZoneIds	array	Não	A lista de IDs de zona. Você pode consultar até 20 IDs de zona por vez.
	string	Não	O ID da zona.	cn-beijing-h
VpcIds	array	Não	A lista de IDs de nuvem privada virtual (VPC). Você pode consultar até 20 IDs de VPC por vez.
	string	Não	O ID da VPC.	vpc-bp1xuejaht4o7yhh2****
AddressIpVersion	string	Não	A versão do protocolo. Valor válido: Ipv4: IPv4. Valores válidos: IPv4 : IPv4 DualStack : Dual-stack.	Ipv4
LoadBalancerStatus	string	Não	O status da instância GWLB. Valores válidos: Active: A instância está em execução. Inactive: A instância está parada. Neste estado, o listener da instância não encaminha tráfego. Provisioning: A instância está sendo criada. Configuring: A instância está sendo modificada.	Active
LoadBalancerBusinessStatus	string	Não	O status comercial da instância GWLB. Valores válidos: Normal: A instância está em execução conforme o esperado. FinancialLocked: A instância está bloqueada devido a um pagamento em atraso.	Normal
LoadBalancerNames	array	Não	A lista de nomes de instâncias GWLB. Você pode consultar até 20 nomes de instâncias por vez.
	string	Não	O nome da instância GWLB.	testGwlbName
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-aek2htf5qsyrn****
LoadBalancerIds	array	Não	A lista de IDs de instâncias GWLB. Você pode consultar até 20 IDs de instâncias por vez.
	string	Não	O ID da instância GWLB.	gwlb-cp6prgqy40hols****
TrafficMode	string	Não	O modo de tráfego. Valores válidos: LoadBalance: A instância está no modo de balanceamento de carga. ByPass: A instância está no modo de bypass.	LoadBalance
Tag	array<object>	Não	A lista de tags. Você pode especificar até 20 tags em cada chamada.
	object	Não	O objeto de tag.
Key	string	Não	A chave da tag. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	testTagKey
Value	string	Não	O valor da tag. O valor da tag pode ter até 256 caracteres e não pode conter `http://` ou `https://`.	testTagValue
NextToken	string	Não	O token usado para a próxima consulta. Valores válidos: Se NextToken estiver vazio, indica que nenhuma próxima consulta será enviada. Se NextToken tiver um valor, o valor é o token usado para a próxima consulta.	WyJyb290IiwibiIsIm4iLDEsMCwxNjg1MDY1NTgyNzYwLCI2NDcwMGY2ZTc2Zjc0MWFiZGEyZjQyNzc4ZDk2MmJkOTk3ZGZmM2Nm****
MaxResults	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 1 a 1000. Valor padrão: 20.	20
Skip	integer	Não	O número de entradas a serem ignoradas.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
LoadBalancers	array<object>	A lista de instâncias GWLB.
	array<object>	A instância GWLB.
AddressIpVersion	string	A versão do protocolo. Valor válido: IPv4: IPv4.	IPv4
CreateTime	string	A hora em que o recurso foi criado. A hora é exibida em UTC e segue o formato yyyy-MM-ddTHH:mm:ssZ.	2024-08-05T18:24:07Z
LoadBalancerBusinessStatus	string	O status comercial da instância GWLB. Valores válidos: Normal: A instância está em execução conforme o esperado. FinancialLocked: A instância está bloqueada devido a um pagamento em atraso.	Normal
LoadBalancerId	string	O ID da instância GWLB.	gwlb-9njtjmqt7zfcqm****
LoadBalancerName	string	O nome da instância GWLB. O nome deve ter de 2 a 128 caracteres, começar com uma letra ou um caractere chinês e pode conter dígitos, pontos (.), sublinhados (_) e hifens (-).	testGwlbName
LoadBalancerStatus	string	O status da instância GWLB. Valores válidos: Active: A instância está em execução. Inactive: A instância está parada. Neste estado, o listener da instância não encaminha tráfego. Provisioning: A instância está sendo criada. Configuring: A instância está sendo modificada.	Active
ResourceGroupId	string	O ID do grupo de recursos.	rg-aek26jasguy****
Tags	array<object>	A lista de tags.
	object	A tag.
Key	string	The tag key. The tag key cannot be an empty string. The tag key can be up to 128 characters in length, and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	testTagKey
Value	string	The tag value. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length, must start with a letter or a Chinese character, and can contain digits, periods (.), underscores (_), and hyphens (-). The tag value cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	testTagValue
VpcId	string	O ID da VPC.	vpc-uf6eg0vndlsa84n7r****
ZoneMappings	array<object>	A lista de mapeamentos entre zonas e vSwitches. Você deve adicionar pelo menos uma zona e pode adicionar até 20 zonas. Se a região atual suportar duas ou mais zonas, recomendamos que você adicione duas ou mais zonas.
	array<object>	O mapeamento entre uma zona e um vSwitch.
LoadBalancerAddresses	array<object>	The list of addresses of the GWLB instance.
	object	The address of the GWLB instance.
EniId	string	The ID of the elastic network interface (ENI).	eni-bp17qv9zbzyqy629****
PrivateIpv4Address	string	The private IPv4 address.	192.168.XX.XX
VSwitchId	string	The vSwitch in the zone. Each zone uses a vSwitch and a subnet by default.	vsw-2zemule5dz7okwqfv****
ZoneId	string	The zone ID. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-g
MaxResults	integer	O número de entradas retornadas em cada página. Valores válidos: 1 a 1000. Valor padrão: 20.	20
NextToken	string	O token usado para a próxima consulta. Valores válidos: Você não precisa especificar este parâmetro para a primeira solicitação ou se nenhuma solicitação subsequente for enviada. Se uma consulta subsequente for enviada, defina o valor como o valor `NextToken` retornado da chamada de API anterior.	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****
RequestId	string	O ID da solicitação.	378A80E9-4262-5D8E-8D62-0969E52D7358
TotalCount	integer	O número total de entradas retornadas.	100

Exemplos

Resposta de sucesso

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 erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.