DescribeLoadBalancerHTTPListenerAttribute - ENS: Central de Documentação do Alibaba Cloud

Consulta a configuração de um listener HTTP.

Descrição da operação

até 100 vezes por segundo por conta.
até 10 vezes por segundo por usuário.

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

ens:DescribeLoadBalancerHTTPListenerAttribute

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ListenerPort	integer	Sim	A porta do listener que você deseja consultar. Valores válidos: 1 a 65535.	80
LoadBalancerId	string	Sim	O ID da instância ELB.	lb-5snthcyu1x10g7tywj7iu****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
ListenerPort	integer	A porta do listener.	80
Status	string	O status do listener. Valores válidos: Running Stopped Starting Configuring Stopping	Running
Bandwidth	integer	A largura de banda de pico da instância do Edge Load Balancer (ELB). O valor padrão é -1, o que indica que a largura de banda não é limitada.	-1
Scheduler	string	O algoritmo de roteamento. Valores válidos: wrr: Servidores de backend com pesos maiores recebem mais solicitações do que aqueles com pesos menores. wlc: As solicitações são distribuídas com base no peso e na carga de cada servidor de backend. A carga refere-se ao número de conexões com um servidor de backend. Se dois servidores de backend tiverem o mesmo peso, o servidor de backend que tiver menos conexões receberá mais solicitações. rr: As solicitações são distribuídas para os servidores de backend em sequência. sch: hash consistente baseado em endereços IP de origem. As solicitações do mesmo endereço IP de origem são distribuídas para o mesmo servidor de backend. qch: hash consistente baseado em IDs de conexão QUIC. As solicitações que contêm o mesmo ID de conexão QUIC são distribuídas para o mesmo servidor de backend. iqch: hash consistente baseado em três bytes específicos dos CIDs iQUIC. As solicitações cujos segundo a quarto bytes são iguais são distribuídas para o mesmo servidor de backend.	wrr
HealthCheck	string	Indica se o recurso de verificação de integridade está ativado. Valores válidos: on off	on
HealthyThreshold	integer	O número de verificações de integridade bem-sucedidas consecutivas que devem ocorrer antes que um servidor de backend não íntegro e inacessível seja declarado íntegro e acessível. Valores válidos: 2 a 10. Nota Este parâmetro é retornado apenas se você definir HealthCheck como on.	3
UnhealthyThreshold	integer	O número de verificações de integridade com falha consecutivas que devem ocorrer antes que um servidor de backend íntegro e acessível seja declarado não íntegro e inacessível. Valores válidos: 2 a 10. Nota Este parâmetro é retornado apenas se você definir HealthCheck como on.	3
HealthCheckTimeout	integer	O período de tempo limite de uma resposta de verificação de integridade. Se um servidor de backend não responder dentro do período de tempo limite especificado, o servidor falhará na verificação de integridade. Valor padrão: 5. Valores válidos: 1 a 300. Unidade: segundos. Nota Este parâmetro entra em vigor apenas se o parâmetro HealthCheck estiver definido como on. Se o valor de HealthCheckTimeout for menor que o valor de HealthCheckInterval, o período de tempo limite especificado por HealthCheckTimeout se tornará inválido e o valor de HealthCheckInterval será usado como o período de tempo limite.	10
HealthCheckConnectPort	integer	A porta usada para verificações de integridade. Valores válidos: 1 a 65535. Se você deixar este parâmetro vazio, a porta especificada por BackendServerPort será usada para verificações de integridade. Nota Este parâmetro é retornado apenas se você definir HealthCheck como on.	5000
HealthCheckInterval	integer	O intervalo no qual as verificações de integridade são realizadas. Valores válidos: 1 a 50. Unidade: segundos. Nota Este parâmetro é retornado apenas se você definir HealthCheck como on.	5
Description	string	A descrição do listener. A descrição deve ter de 1 a 80 caracteres. Nota O valor não pode começar com `http://` ou `https://`.	abc
ListenerForward	string	Indica se o redirecionamento de HTTP para HTTPS está ativado. Valores válidos: on: O redirecionamento de HTTP para HTTPS está ativado. off (padrão)	off
ForwardPort	integer	A porta do listener usada para redirecionar solicitações HTTP para HTTPS.	10002
RequestTimeout	integer	O período de tempo limite das solicitações. Valor padrão: 60. Valores válidos: 1 a 180. Unidade: segundos. Nota Se nenhuma resposta for recebida do servidor de backend dentro do período de tempo limite especificado, o ELB retornará um código de erro HTTP 504 ao cliente.	60
IdleTimeout	integer	O período de tempo limite para conexões ociosas. Valor padrão: 15. Valores válidos: 1 a 60. Unidade: segundos. Nota Se nenhuma solicitação for recebida dentro do período de tempo limite especificado, o ELB fechará a conexão. Quando outra solicitação for recebida, o ELB estabelecerá uma nova conexão.	15
HealthCheckHttpCode	string	Os códigos de status HTTP para uma verificação de integridade bem-sucedida. Valores válidos: http_2xx (padrão) http_3xx. http_4xx http_5xx Nota Este parâmetro é retornado apenas se você definir HealthCheck como on.	http_2xx
HealthCheckDomain	string	O nome de domínio usado para verificações de integridade. Nota Este parâmetro é retornado apenas se você definir HealthCheck como on.	www.example.com
HealthCheckURI	string	O URI usado para verificações de integridade. O URI deve ter de 1 a 80 caracteres. Nota Uma URL deve começar com uma barra (`/`), mas não pode conter apenas barras (`/`). Este parâmetro entra em vigor apenas se o parâmetro HealthCheck estiver definido como on.	/checkpreload.htm
ServerCertificateId	string	O ID do certificado do servidor.	6027667
HealthCheckMethod	string	O método de verificação de integridade usado nas verificações de integridade HTTP. Valores válidos: head: solicita o cabeçalho da página. get: solicita a parte especificada da página e retorna o corpo da entidade. Nota Este parâmetro é retornado apenas se você definir HealthCheck como on.	head
XForwardedFor	string	Indica se o cabeçalho X-Forwarded-For é usado para obter o endereço IP real do cliente. Valores válidos: on (padrão) off	on
BackendServerPort	integer	A porta usada pelo servidor de backend da instância ELB. Valores válidos: 1 a 65535.	8080

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ListenerPort": 80,
  "Status": "Running",
  "Bandwidth": -1,
  "Scheduler": "wrr",
  "HealthCheck": "on",
  "HealthyThreshold": 3,
  "UnhealthyThreshold": 3,
  "HealthCheckTimeout": 10,
  "HealthCheckConnectPort": 5000,
  "HealthCheckInterval": 5,
  "Description": "abc",
  "ListenerForward": "off",
  "ForwardPort": 10002,
  "RequestTimeout": 60,
  "IdleTimeout": 15,
  "HealthCheckHttpCode": "http_2xx",
  "HealthCheckDomain": "www.example.com",
  "HealthCheckURI": "/checkpreload.htm",
  "ServerCertificateId": "6027667",
  "HealthCheckMethod": "head",
  "XForwardedFor": "on\n",
  "BackendServerPort": 8080
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	LoadBalancerNotFound	The input parameter loadBalancerId that is not found.
400	ListenerNotFound	Listener is not found.	Listener does not exist
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.