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

Chama DescribeLoadBalancerUDPListenerAttribute para obter a configuração de um listener UDP.

Descrição da operação

Limite de taxa da API: 100 solicitações por segundo (RPS).
Limite de taxa por usuário: 10 RPS.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ListenerPort	integer	Sim	A porta do listener a ser consultada. Valores válidos: 1 a 65535.	80
LoadBalancerId	string	Sim	O ID do load balancer.	lb-5pzipr2fszqtl2xf64uy5****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema da resposta.
RequestId	string	O ID da solicitação.	5D7597CF-1630-54EC-A945-624A33F2E7E8
ListenerPort	integer	A porta do listener.	80
Status	string	O status do listener. Valores válidos: Running: O listener está em execução. Stopped: O listener está parado. Starting: O listener está iniciando. Configuring: O listener está sendo configurado. Stopping: O listener está sendo parado.	Stopped
Bandwidth	integer	A largura de banda de pico do load balancer. Um valor de -1 indica que nenhum limite de taxa é aplicado.	5
Scheduler	string	O algoritmo de agendamento. Valores válidos: wrr (Weighted Round Robin): Servidores de back-end com pesos maiores recebem uma proporção maior de solicitações. wlc (Weighted Least Connections): As solicitações são distribuídas com base no peso e na contagem atual de conexões de cada servidor de back-end. Se os servidores de back-end tiverem o mesmo peso, o servidor com o menor número de conexões receberá mais novas solicitações. rr (Round Robin): As solicitações são distribuídas para os servidores de back-end sequencialmente. sch (Source IP Hash): Roteia solicitações do mesmo endereço IP de origem para o mesmo servidor de back-end usando um hash consistente do endereço IP de origem. tch (4-tuple Hash): Roteia pacotes do mesmo fluxo para o mesmo servidor de back-end usando um hash consistente da 4-tuple (endereço IP de origem, endereço IP de destino, porta de origem e porta de destino). qch (QUIC Connection ID Hash): Usa um algoritmo de hash consistente no ID de conexão QUIC para garantir que as solicitações com o mesmo ID de conexão sejam sempre roteadas para o mesmo servidor de back-end. iqch (iQUIC CID Hash): Usa um algoritmo de hash consistente nos bytes 2, 3 e 4 do CID iQUIC. As solicitações em que esses três bytes são iguais são roteadas para o mesmo servidor de back-end.	wrr
HealthCheck	string	Especifica se os health checks devem ser ativados. Valores válidos: on: Ativado. off: Desativado.	on
HealthyThreshold	integer	O número de health checks consecutivos bem-sucedidos que devem ocorrer antes que um servidor de back-end possa ser declarado íntegro. Valores válidos: 2 a 10. Nota Este parâmetro entra em vigor apenas quando HealthCheck está definido como on.	4
UnhealthyThreshold	integer	O número de health checks consecutivos com falha que devem ocorrer antes que um servidor de back-end possa ser declarado não íntegro. Valores válidos: 2 a 10. Nota Este parâmetro entra em vigor apenas quando HealthCheck está definido como on.	4
HealthCheckConnectTimeout	integer	O período de tempo limite para uma resposta de health check. Se uma instância ENS de back-end não responder dentro do período de tempo limite especificado, o health check falhará. Valor padrão: 5. Valores válidos: 1 a 300. Unidade: segundos. Nota Este parâmetro entra em vigor apenas quando HealthCheck está definido como on. Se o valor de HealthCheckConnectTimeout for menor que o valor de HealthCheckInterval, o valor de HealthCheckInterval será usado como o período de tempo limite.	100
HealthCheckInterval	integer	O intervalo entre health checks. Valores válidos: 1 a 50. Unidade: segundos. Nota Este parâmetro entra em vigor apenas quando HealthCheck está definido como on.	5
Description	string	O nome do listener.	example
BackendServerPort	integer	A porta usada pelos servidores de back-end. Valores válidos: 1 a 65535.	8080
HealthCheckConnectPort	integer	A porta usada para health checks. Valores válidos: 1 a 65535. Se você não especificar este parâmetro, o valor de BackendServerPort será usado.	8000
HealthCheckReq	string	A string de solicitação para health checks UDP. A string pode conter apenas letras e dígitos e pode ter até 64 caracteres.	hello
HealthCheckExp	string	A string de resposta para health checks UDP. A string pode conter apenas letras e dígitos e pode ter até 64 caracteres.	ok
EipTransmit	string	Especifica se o passthrough de EIP deve ser ativado. Valores válidos: on: Ativado. off (padrão): Desativado.	on
EstablishedTimeout	integer	O período de tempo limite da conexão. Valores válidos: 10 a 900. Unidade: segundos.	500

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "5D7597CF-1630-54EC-A945-624A33F2E7E8",
  "ListenerPort": 80,
  "Status": "Stopped",
  "Bandwidth": 5,
  "Scheduler": "wrr",
  "HealthCheck": "on",
  "HealthyThreshold": 4,
  "UnhealthyThreshold": 4,
  "HealthCheckConnectTimeout": 100,
  "HealthCheckInterval": 5,
  "Description": "example",
  "BackendServerPort": 8080,
  "HealthCheckConnectPort": 8000,
  "HealthCheckReq": "hello",
  "HealthCheckExp": "ok",
  "EipTransmit": "on",
  "EstablishedTimeout": 500
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ListenerNotFound	Listener is not found.	Listener does not exist
400	LoadBalancerNotFound	The input parameter LoadBalancerId that is not found.	The load balancing instance 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.