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

Consulta as instâncias SLB criadas.

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

slb:DescribeLoadBalancers

get

*LoadBalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância do Classic Load Balancer (CLB). Você pode chamar a operação DescribeRegions para consultar os IDs das regiões.	cn-hangzhou
ServerId	string	Não	O ID do servidor de back-end que é adicionado à instância CLB.	i-2zebcbq******
AddressIPVersion	string	Não	A versão do IP. Defina o valor como ipv4 ou ipv6.	ipv4
LoadBalancerStatus	string	Não	O estado da instância. Valores válidos: inactive: A instância está parada. Os listeners de uma instância neste estado não encaminham tráfego. active: A instância está em execução. Este é o estado padrão de uma instância após a sua criação. locked: A instância está bloqueada. Uma instância entra no estado bloqueado após expirar. Este estado dura sete dias. Você não pode realizar operações na instância. A instância não encaminha tráfego, mas seu endereço IP e outras configurações são retidos.	active
LoadBalancerId	string	Não	O ID da instância CLB. Você pode especificar até 10 IDs, separados por vírgulas (,).	lb-bp1b6c719dfa****
LoadBalancerName	string	Não	O nome da instância CLB. O nome deve ter de 1 a 80 caracteres. Deve começar com uma letra ou um caractere chinês. Pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-). Você pode especificar até 10 nomes. Separe vários nomes com vírgulas (,).	test
ServerIntranetAddress	string	Não	O endereço IP interno do servidor de back-end adicionado. Você pode especificar vários endereços IP. Separe-os com vírgulas (,).	10.XX.XX.102
AddressType	string	Não	O tipo de rede da instância CLB. Valores válidos: internet: Uma instância CLB voltada para a Internet. O sistema atribui um endereço IP público à instância. A instância pode encaminhar solicitações da Internet. intranet: Uma instância CLB voltada para a rede interna. O sistema atribui um endereço IP privado à instância. A instância pode encaminhar solicitações apenas dentro de redes internas.	intranet
InternetChargeType	string	Não	O método de cobrança da instância CLB voltada para a Internet. Valores válidos: paybybandwidth: pagamento por largura de banda. paybytraffic: pagamento por transferência de dados.	paybytraffic
VpcId	string	Não	O ID da virtual private cloud (VPC) à qual a instância CLB pertence.	vpc-bp1aevy8sof****
VSwitchId	string	Não	O ID do vSwitch ao qual a instância CLB pertence.	vsw-bp12mw1f8k3****
NetworkType	string	Não	O tipo de rede da instância CLB voltada para a rede interna. Valores válidos: vpc: uma VPC. classic: uma rede clássica.	vpc
Address	string	Não	O endereço de serviço da instância CLB.	192.168.XX.XX
MasterZoneId	string	Não	O ID da zona primária da instância CLB.	cn-hangzhou-b
SlaveZoneId	string	Não	O ID da zona secundária da instância CLB. O recurso de múltiplas zonas não está disponível para usuários do Alibaba Finance Cloud.	cn-hangzhou-d
Tags	string	Não	As tags que são adicionadas à instância CLB. O valor é um dicionário JSON que consiste em chaves de tag e valores de tag. Você pode adicionar até 10 tags em cada solicitação.	[{"tagKey":"Key1","tagValue":"Value1"}]
PayType	string	Não	O método de cobrança da instância CLB. Valores válidos: PayOnDemand: pago conforme o uso.	PayOnDemand
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmxazb4p****
PageNumber	integer	Não	O número da página a ser retornada.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 1 a 100. Nota Se você definir PageSize, também deverá definir PageNumber.	50
Tag	array<object>	Não	A lista de tags.
	object	Não	A lista de tags.
Key	string	Não	A chave da tag N. Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 64 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	FinanceDept
Value	string	Não	O valor da tag N. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia. O valor da tag pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	FinanceJoshua

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E
PageNumber	integer	O número da página retornada.	1
PageSize	integer	O número de entradas retornadas na página atual.	50
TotalCount	integer	O número total de instâncias que atendem às condições de filtro.	1
LoadBalancers	object
LoadBalancer	array<object>	A lista de instâncias CLB.
	array<object>	A lista de instâncias CLB.
VpcId	string	The ID of the VPC in which the internal-facing CLB instance is deployed.	vpc-25dvzy9f8****
CreateTimeStamp	integer	The timestamp that indicates when the instance was created.	1504147745000
LoadBalancerId	string	The ID of the CLB instance.	lb-bp1b6c719dfa****
CreateTime	string	The time when the instance was created. The time is in the `YYYY-MM-DDThh:mm:ssZ` format.	2021-12-02T02:49:05Z
PayType	string	The billing method of the CLB instance. Valid values: PayOnDemand: pay-as-you-go.	PayOnDemand
AddressType	string	The network type of the instance. Valid values: internet: An Internet-facing CLB instance. The system assigns a public IP address to the instance. The instance can forward requests from the Internet. intranet: An internal-facing CLB instance. The system assigns a private IP address to the instance. The instance can forward requests only within internal networks.	intranet
NetworkType	string	The network type of the internal-facing CLB instance. Valid values: vpc: a VPC. classic: a classic network.	vpc
AddressIPVersion	string	The IP version. Valid values: ipv4 and ipv6.	ipv4
LoadBalancerName	string	The name of the CLB instance.	lb-bp1o94dp5i6ea****
Bandwidth	integer	The peak bandwidth of the listener. Unit: Mbit/s.	-1
Address	string	The service address of the CLB instance.	100.XX.XX.28
SlaveZoneId	string	The ID of the secondary zone of the instance.	cn-hangzhou-d
MasterZoneId	string	The ID of the primary zone of the instance.	cn-hangzhou-b
InternetChargeTypeAlias	string	The billing method of the Internet-facing CLB instance. Valid values: paybybandwidth: pay-by-bandwidth. paybytraffic: pay-by-data-transfer	paybybandwidth
LoadBalancerSpec	string	The specification of the CLB instance. Nota Pay-by-data-transfer instances have no specification. The default value slb.lcu.elastic is returned.	slb.s1.small
RegionId	string	The region ID of the CLB instance.	cn-hangzhou
ModificationProtectionReason	string	The reason why the configuration read-only mode is enabled. The reason must be 1 to 80 characters in length. It must start with a letter or a Chinese character. It can contain letters, digits, periods (.), underscores (_), and hyphens (-). Nota This parameter is valid only if `ModificationProtectionStatus` is set to ConsoleProtection.	ManagedInstance
ModificationProtectionStatus	string	The status of the configuration read-only mode: NonProtection: The configuration read-only mode is disabled. After you disable the mode, the value of `ModificationProtectionReason` is cleared. ConsoleProtection: The configuration read-only mode is enabled. Nota If the value is ConsoleProtection, the configuration read-only mode is enabled. You cannot modify the instance configuration in the CLB console. However, you can call API operations to modify the instance configuration.	ConsoleProtection
VSwitchId	string	The ID of the vSwitch in the VPC where the internal-facing CLB instance is deployed.	vsw-255ecr****
LoadBalancerStatus	string	The state of the CLB instance. Valid values: inactive: The instance is stopped. Listeners of an instance in this state do not forward traffic. active: The instance is running. This is the default state of an instance after it is created. locked: The instance is locked.	active
ResourceGroupId	string	The ID of the resource group.	rg-atstuj3r****
InternetChargeType	string	The billing method of the Internet-facing instance. Valid values: 3: pay-by-bandwidth. 4: pay-by-data-transfer.	3
DeleteProtection	string	Indicates whether deletion protection is enabled for the CLB instance. Valid values: on: enabled. off: disabled.	off
RegionIdAlias	string	The name of the region where the CLB instance is deployed.	cn-hangzhou
Tags	object
Tag	array<object>	The list of tags
	object	The list of tags
TagValue	string	The tag value.	testvalue
TagKey	string	The tag key.	testkey

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "LoadBalancers": {
    "LoadBalancer": [
      {
        "VpcId": "vpc-25dvzy9f8****",
        "CreateTimeStamp": 1504147745000,
        "LoadBalancerId": "lb-bp1b6c719dfa****",
        "CreateTime": "2021-12-02T02:49:05Z",
        "PayType": "PayOnDemand",
        "AddressType": "intranet",
        "NetworkType": "vpc",
        "AddressIPVersion": "ipv4",
        "LoadBalancerName": "lb-bp1o94dp5i6ea****",
        "Bandwidth": -1,
        "Address": "100.XX.XX.28",
        "SlaveZoneId": "cn-hangzhou-d",
        "MasterZoneId": "cn-hangzhou-b",
        "InternetChargeTypeAlias": "paybybandwidth",
        "LoadBalancerSpec": "slb.s1.small",
        "RegionId": "cn-hangzhou",
        "ModificationProtectionReason": "ManagedInstance",
        "ModificationProtectionStatus": "ConsoleProtection",
        "VSwitchId": "vsw-255ecr****",
        "LoadBalancerStatus": "active",
        "ResourceGroupId": "rg-atstuj3r****",
        "InternetChargeType": "3",
        "DeleteProtection": "off",
        "RegionIdAlias": "cn-hangzhou",
        "Tags": {
          "Tag": [
            {
              "TagValue": "testvalue",
              "TagKey": "testkey"
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidTag	The specified tags is invalid.
400	TooManyResult	fuzzy query retrieve too many instances.
400	LocationServiceTimeout	Location service connection timeout. Please try again later.
403	UnauthorizedRegion	The specified region of is not authorized.	The specified region of is not authorized.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.