Todos os produtos
Search

Este produto

    ENS:DescribeLoadBalancerTCPListenerAttribute

    Central de documentação

    ENS:DescribeLoadBalancerTCPListenerAttribute

    Última atualização: Jun 29, 2026

    Chama a operação DescribeLoadBalancerTCPListenerAttribute para consultar a configuração de um listener TCP.

    Descrição da operação

    • Taxa de chamadas da API: 100 chamadas por segundo.

    • Taxa de chamadas por usuário: 10 chamadas por segundo.

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

    get

    *All Resource

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    ListenerPort

    integer

    Sim

    A porta do listener. Valores válidos: 1 a 65535.

    80
    LoadBalancerId

    string

    Sim

    O ID da instância do load balancer.

    lb-5snthcyu1x10g7tywj7iu****

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    O esquema da resposta.

    RequestId

    string

    O ID da solicitação.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    ListenerPort

    integer

    A porta de frontend usada pela instância do load balancer.

    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á sendo iniciado.

    • Configuring: O listener está sendo configurado.

    • Stopping: O listener está sendo parado.

    Stopped
    Bandwidth

    integer

    A largura de banda de pico do load balancer. O valor padrão é -1, o que indica largura de banda ilimitada.

    -1
    Scheduler

    string

    O algoritmo de agendamento. Valores válidos:

    • wrr: Weighted Round Robin. Servidores de backend com pesos maiores recebem mais solicitações.

    • wlc: Weighted Least Connections. Além dos pesos, o sistema considera o número de conexões ativas para cada servidor de backend. Se vários servidores de backend tiverem o mesmo peso, o sistema selecionará o servidor de backend com o menor número de conexões ativas.

    • rr: Round Robin. O sistema distribui solicitações sequencialmente para os servidores de backend.

    • sch: Source IP Hash. O sistema roteia solicitações do mesmo endereço IP de origem para o mesmo servidor de backend.

    • tch: 4-Tuple Hash. O sistema roteia solicitações que compartilham a mesma 4-tupla (endereço IP de origem, endereço IP de destino, porta de origem e porta de destino) para o mesmo servidor de backend.

    wrr
    PersistenceTimeout

    integer

    O tempo limite de persistência de sessão.

    • Valor padrão: 0. Um valor 0 indica que a persistência de sessão está desativada.

    • Valores válidos: 0 a 3600.

    • Unidade: segundos.

    0
    EstablishedTimeout

    integer

    O tempo limite de conexão. Valores válidos: 10 a 900. Unidade: segundos.

    500
    HealthCheck

    string

    Especifica se as verificações de integridade devem ser ativadas. Valores válidos:

    • on: ativar

    • off: desativar

    on
    HealthyThreshold

    integer

    O número de verificações de integridade bem-sucedidas consecutivas necessárias para alterar o status de integridade de um servidor de backend de fail (não íntegro) para success (íntegro). Valores válidos: 2 a 10.

    Nota

    Este parâmetro entra em vigor apenas quando o parâmetro HealthCheck está definido como on.

    4
    UnhealthyThreshold

    integer

    O número de verificações de integridade com falha consecutivas necessárias para alterar o status de integridade de um servidor de backend de success (íntegro) para fail (não íntegro). Valores válidos: 2 a 10.

    Nota

    Este parâmetro entra em vigor apenas quando o parâmetro HealthCheck está definido como on.

    4
    HealthCheckConnectTimeout

    integer

    O tempo limite de resposta para uma verificação de integridade. Se uma instância ENS de backend não responder dentro desse período de tempo limite, a verificação de integridade falhará.

    • Valor padrão: 5.

    • Valores válidos: 1 a 300.

    • Unidade: segundos.

    Nota

    • Este parâmetro entra em vigor apenas quando o parâmetro HealthCheck está definido como on.

    • Se este valor 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 as verificações de integridade. Valores válidos: 1 a 50. Unidade: segundos.

    5
    Description

    string

    A descrição do listener.

    example
    HealthCheckHttpCode

    string

    Os códigos de status HTTP que indicam uma verificação de integridade bem-sucedida. Valores válidos:

    • http_2xx (Padrão)

    • http_3xx

    • http_4xx

    • http_5xx

    Nota

    Este parâmetro entra em vigor apenas quando o parâmetro HealthCheck está definido como on.

    http_2xx
    HealthCheckDomain

    string

    O nome de domínio usado para verificações de integridade.

    Nota

    Este parâmetro entra em vigor apenas quando o parâmetro HealthCheck está definido como on.

    example.com
    HealthCheckURI

    string

    A URI usada para verificações de integridade. Comprimento: 1 a 80 caracteres.

    Nota

    • A URI deve começar com /, mas não pode consistir apenas em /.

    • Este parâmetro entra em vigor apenas quando o parâmetro HealthCheck está definido como on.

    /example/index.html
    HealthCheckType

    string

    O tipo de verificação de integridade. Valores válidos:

    • tcp (Padrão)

    • http

    tcp
    BackendServerPort

    integer

    A porta usada pelos servidores de backend. Valores válidos: 1 a 65535.

    8080
    HealthCheckConnectPort

    integer

    A porta usada para verificações de integridade. Valores válidos: 1 a 65535. Se este parâmetro não for especificado, o valor de BackendServerPort será usado.

    Nota

    Este parâmetro entra em vigor apenas quando o parâmetro HealthCheck está definido como on.

    8000
    EipTransmit

    string

    Especifica se o passthrough de EIP está ativado. Valores válidos:

    • on: ativar

    • off (Padrão): desativar

    on

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ListenerPort": 80,
  "Status": "Stopped",
  "Bandwidth": -1,
  "Scheduler": "wrr",
  "PersistenceTimeout": 0,
  "EstablishedTimeout": 500,
  "HealthCheck": "on",
  "HealthyThreshold": 4,
  "UnhealthyThreshold": 4,
  "HealthCheckConnectTimeout": 100,
  "HealthCheckInterval": 5,
  "Description": "example",
  "HealthCheckHttpCode": "http_2xx",
  "HealthCheckDomain": "example.com",
  "HealthCheckURI": "/example/index.html",
  "HealthCheckType": "tcp",
  "BackendServerPort": 8080,
  "HealthCheckConnectPort": 8000,
  "EipTransmit": "on"
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 ens.interface.error An error occurred while call the API.
    400 LoadBalancerNotFound The input parameter loadBalancerId that is not found.
    400 ListenerNotFound Listener is not found. Listener does not exist
    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.