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

Consulta os detalhes de uma instância do Classic Load Balancer (CLB).

Descrição da operação

Nota

Se os servidores backend estiverem implantados em um grupo vServer, você pode chamar a operação DescribeVServerGroupAttribute para consultar os servidores backend.

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:DescribeLoadBalancerAttribute

get

*loadbalancer

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

slb:tag
slb:tag
slb:tag
slb:tag
slb:tag

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região da instância CLB. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
LoadBalancerId	string	Sim	O ID da instância CLB.	lb-bp1b6c719dfa08ex****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
VpcId	string	O ID da virtual private cloud (VPC) onde a instância CLB interna está implantada.	vpc-25dvzy9f8****
Tags	object
Tag	array<object>	As tags.
	object
TagKey	string	The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be at most 64 characters in length, and cannot contain `http://` or `https://`. It must not start with `aliyun` or `acs:`.	test
TagValue	string	The tag value. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag value cannot contain `http://` or `https://`.	value
CreateTimeStamp	integer	O timestamp gerado quando o certificado CA é carregado.	1504147745000
CreateTime	string	A hora em que a instância CLB foi criada. A hora está no formato `YYYY-MM-DDThh:mm:ssZ`.	2017-08-31T02:49:05Z
LoadBalancerId	string	O ID da instância CLB.	lb-bp1b6c719dfa08ex****
PayType	string	O método de cobrança da instância CLB. Valores válidos: Apenas PayOnDemand pode ser retornado, o que indica o método de cobrança pay-as-you-go.	PayOnDemand
AddressType	string	O tipo de endereço da instância CLB.	internet
NetworkType	string	O tipo de rede da instância CLB.	vpc
AddressIPVersion	string	A versão do endereço IP. Valores válidos: ipv4 e ipv6.	ipv4
RenewalCycUnit	string	O ciclo de renovação automática. Valores válidos: Year e Month. Valor padrão: Month. Nota Este parâmetro é válido apenas se você criar uma instância CLB por assinatura no site da Alibaba Cloud China. Nesse caso, PayType deve ser definido como PrePay e RenewalStatus deve ser definido como AutoRenewal.	Month
RequestId	string	O ID da solicitação.	365F4154-92F6-4AE4-92F8-7FF34B540710
Bandwidth	integer	A largura de banda máxima da instância CLB voltada para a Internet que é cobrada com base em pay-by-bandwidth.	5
LoadBalancerName	string	O nome da instância CLB.	lb-instance-test
Address	string	O endereço IP de serviço da instância CLB.	42.XX.XX.6
SlaveZoneId	string	O ID da zona secundária à qual a instância CLB pertence.	cn-hangzhou-d
EndTimeStamp	integer	O timestamp que indica a hora de expiração da instância CLB.	3249380160000
MasterZoneId	string	O ID da zona primária à qual a instância CLB pertence.	cn-hangzhou-b
LoadBalancerSpec	string	A especificação da instância CLB. Nota Instâncias CLB pay-as-you-go não estão sujeitas a especificações. Por padrão, slb.lcu.elastic é retornado.	slb.s1.small
AutoReleaseTime	integer	O timestamp gerado quando a instância CLB é liberada.	1513947075000
ModificationProtectionReason	string	O motivo pelo qual o modo somente leitura de configuração está ativado. O valor tem de 1 a 80 caracteres. Começa com uma letra e pode conter dígitos, pontos (.), underscores (_) e hífens (-). Nota Este parâmetro é válido apenas quando ModificationProtectionStatus está definido como ConsoleProtection.	Instance service guarantee period
RegionId	string	O ID da região da instância CLB.	cn-hangzhou
ModificationProtectionStatus	string	Indica se o modo somente leitura de configuração está ativado. Valores válidos: NonProtection: O modo somente leitura de configuração está desativado. Após desativar o modo somente leitura de configuração, o valor de ModificationProtectionReason é limpo. ConsoleProtection: O modo somente leitura de configuração está ativado. Nota Se este parâmetro estiver definido como ConsoleProtection, você não poderá modificar as configurações da instância no console do CLB. No entanto, você pode modificar as configurações da instância chamando operações de API.	ConsoleProtection
EndTime	string	A hora em que a instância CLB expira.	2022-09-08T16:00:00Z
VSwitchId	string	O ID do vSwitch ao qual a instância CLB interna pertence.	vsw-255ecrwq5****
LoadBalancerStatus	string	O status da instância CLB. Valores válidos: inactive: A instância CLB está desativada. Instâncias CLB no estado inactive não encaminham tráfego. active: A instância CLB está funcionando conforme esperado. Instâncias CLB recém-criadas estão no estado active por padrão. locked: A instância CLB está bloqueada. Instâncias CLB podem ser bloqueadas devido a pagamentos em atraso ou outros motivos.	active
ResourceGroupId	string	O ID do grupo de recursos.	rg-atstuj3rtop****
InternetChargeType	string	O método de medição da instância CLB voltada para a Internet. Valores válidos: paybytraffic paybybandwidth	paybytraffic
DeleteProtection	string	Indica se a proteção contra exclusão está ativada para a instância CLB. Valores válidos: on e off.	off
RegionIdAlias	string	O alias da região à qual a instância CLB pertence.	cn-hangzhou
RenewalStatus	string	Indica se a renovação automática está ativada. Valores válidos: AutoRenewal: A renovação automática está ativada. Normal: A renovação automática está desativada. Você deve renovar manualmente a instância CLB. NotRenewal: A instância CLB não será renovada após a expiração. Se este valor for retornado, o sistema não enviará notificações até três dias antes da data de expiração. Observação Este parâmetro é válido apenas quando você cria uma instância CLB por assinatura no site da Alibaba Cloud China. Nesse caso, PayType deve ser definido como PrePay**.	AutoRenewal
RenewalDuration	integer	A duração da renovação automática. Este parâmetro é válido apenas se RenewalStatus estiver definido como AutoRenewal. Valores válidos quando PeriodUnit está definido como Year: 1~5. Valores válidos quando PeriodUnit está definido como Month: 1~ 9. Nota Este parâmetro é válido apenas quando você cria uma instância CLB por assinatura no site da Alibaba Cloud China. Nesse caso, o parâmetro PayType deve ser definido como PrePay.	1
ListenerPorts	object
ListenerPort	array	A porta frontend usada pela instância CLB.
	integer	A porta frontend usada pela instância CLB.	80
ListenerPortsAndProtocal	object
ListenerPortAndProtocal	array<object>	As portas ou protocolos dos listeners.
	object
ListenerProtocal	string	The frontend protocol that is used by the CLB instance.	http
ListenerPort	integer	The frontend port that is used by the CLB instance.	443
ListenerPortsAndProtocol	object
ListenerPortAndProtocol	array<object>	As portas ou protocolos dos listeners.
	object
ListenerPort	integer	The frontend port that is used by the CLB instance.	80
ListenerProtocol	string	The frontend protocol that is used by the CLB instance.	https
ListenerForward	string	Indicates whether the listener is enabled.	on
Description	string	Indicates whether the listener is enabled.	The description of listener port and protocol.
ForwardPort	integer	The destination listening port to which requests are forwarded. The port must be open and use HTTPS.	443
BackendServers	object
BackendServer	array<object>	Os servidores backend da instância CLB.
	object
Type	string	The type of the backend server.	ecs
Weight	integer	The weight of the backend server.	90
Description	string	The description of the backend server. Nota This parameter is not returned if Description is not set.	Backend servers
ServerIp	string	The ID of the elastic network interface (ENI) or elastic container instance.	192.XX.XX.11
ServerId	string	The backend server ID.	i-2zej4lxhjoq1icu*****

Exemplos

Resposta de sucesso

JSON formato

{
  "VpcId": "vpc-25dvzy9f8****",
  "Tags": {
    "Tag": [
      {
        "TagKey": "test",
        "TagValue": "value"
      }
    ]
  },
  "CreateTimeStamp": 1504147745000,
  "CreateTime": "2017-08-31T02:49:05Z",
  "LoadBalancerId": "lb-bp1b6c719dfa08ex****",
  "PayType": "PayOnDemand",
  "AddressType": "internet",
  "NetworkType": "vpc",
  "AddressIPVersion": "ipv4",
  "RenewalCycUnit": "Month",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "Bandwidth": 5,
  "LoadBalancerName": "lb-instance-test",
  "Address": "42.XX.XX.6",
  "SlaveZoneId": "cn-hangzhou-d",
  "EndTimeStamp": 3249380160000,
  "MasterZoneId": "cn-hangzhou-b",
  "LoadBalancerSpec": "slb.s1.small",
  "AutoReleaseTime": 1513947075000,
  "ModificationProtectionReason": "Instance service guarantee period",
  "RegionId": "cn-hangzhou",
  "ModificationProtectionStatus": "ConsoleProtection",
  "EndTime": "2022-09-08T16:00:00Z",
  "VSwitchId": "vsw-255ecrwq5****",
  "LoadBalancerStatus": "active",
  "ResourceGroupId": "rg-atstuj3rtop****",
  "InternetChargeType": "paybytraffic",
  "DeleteProtection": "off",
  "RegionIdAlias": "cn-hangzhou",
  "RenewalStatus": "AutoRenewal",
  "RenewalDuration": 1,
  "ListenerPorts": {
    "ListenerPort": [
      80
    ]
  },
  "ListenerPortsAndProtocal": {
    "ListenerPortAndProtocal": [
      {
        "ListenerProtocal": "http",
        "ListenerPort": 443
      }
    ]
  },
  "ListenerPortsAndProtocol": {
    "ListenerPortAndProtocol": [
      {
        "ListenerPort": 80,
        "ListenerProtocol": "https",
        "ListenerForward": "on",
        "Description": "The description of listener port and protocol.",
        "ForwardPort": 443
      }
    ]
  },
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": 90,
        "Description": "Backend servers",
        "ServerIp": "192.XX.XX.11",
        "ServerId": "i-2zej4lxhjoq1icu*****"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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.