Todos os produtos
Search

Este produto

    Global Accelerator:ListListeners

    Central de documentação

    Global Accelerator:ListListeners

    Última atualização: Sep 17, 2026

    Consulta uma lista de listeners.

    Descrição da operação

    Consulta a lista de listeners em uma instância do Alibaba Cloud Global Accelerator (GA), incluindo o tipo de roteamento, status, timestamp UNIX de criação e informações de porta de cada listener.

    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

    ga:ListListeners

    list

    *Listener

    acs:ga:{#regionId}:{#accountId}:listener/*

    		 Nenhuma 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 Alibaba Cloud Global Accelerator (GA). Defina o valor como cn-hangzhou.

    cn-hangzhou
    PageNumber

    integer

    Não

    O número da página da lista. Valor padrão: 1.

    1
    PageSize

    integer

    Não

    O número de entradas por página para uma consulta paginada. Valor máximo: 50. Valor padrão: 10.

    10
    AcceleratorId

    string

    Sim

    O ID da instância do Alibaba Cloud Global Accelerator (GA).

    ga-bp1odcab8tmno0hdq****
    Protocol

    string

    Não

    O tipo de protocolo de transporte da rede do listener.

    HTTP

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    A lista de informações de resposta.

    TotalCount

    integer

    O número total de entradas na lista.

    1
    Listeners

    array<object>

    As informações do listener.

    array<object>

    As informações do listener.

    Certificates

    array<object>

    As informações do certificado SSL.

    object

    As informações do certificado SSL.

    Type

    string

    O tipo de certificado.

    Atualmente, apenas Server (certificado de servidor) é suportado.

    Server
    Id

    string

    O ID do certificado SSL.

    44983xxxx-cn-hangzhou
    BackendPorts

    array<object>

    As informações da porta do servidor de backend.

    object

    As informações da porta do servidor de backend.

    FromPort

    string

    A porta inicial do servidor de backend.

    80
    ToPort

    string

    A porta final do servidor de backend.

    80
    ListenerId

    string

    O ID do listener.

    lsr-bp1bpn0kn908w4nbw****
    Description

    string

    A descrição do listener.

    Listener
    State

    string

    O status do listener.

    • active: Normal.

    • init: Inicializando.

    • updating: Sendo configurado.

    • deleting: Sendo excluído.

    active
    ClientAffinity

    string

    A afinidade do cliente.

    • Se NONE for retornado, a afinidade do cliente não será mantida. As conexões do mesmo cliente nem sempre são direcionadas para o mesmo endpoint.

    • Se SOURCE_IP for retornado, a afinidade do cliente será mantida. Quando um cliente acessa um aplicativo com estado, todas as solicitações do mesmo cliente são direcionadas para o mesmo endpoint, independentemente da porta de origem e do protocolo.

    SOURCE_IP
    Protocol

    string

    O tipo de protocolo de transporte do listener.

    • TCP: Protocolo TCP.

    • UDP: Protocolo UDP.

    • HTTP: Protocolo HTTP.

    • HTTPS: Protocolo HTTPS.

    TCP
    CreateTime

    integer

    O timestamp de quando o listener foi criado. Unidade: milissegundos.

    1577786252000
    PortRanges

    array<object>

    As informações de porta do listener.

    object

    As informações de porta do listener.

    FromPort

    integer

    A porta de escuta inicial usada para receber solicitações e encaminhá-las aos endpoints.

    20
    ToPort

    integer

    A porta de escuta final usada para receber solicitações e encaminhá-las aos endpoints.

    20
    Name

    string

    O nome do listener.

    Listener
    ProxyProtocol deprecated

    boolean

    Indica se o recurso de preservação do endereço IP de origem do cliente está ativado.

    • true: O recurso de preservação do endereço IP de origem do cliente está ativado. Após a ativação desse recurso, o serviço de backend pode visualizar o endereço IP original do cliente.

    • false: O recurso de preservação do endereço IP de origem do cliente não está ativado.

    true
    AcceleratorId

    string

    O ID da instância do Alibaba Cloud Global Accelerator (GA).

    ga-bp1odcab8tmno0hdq****
    XForwardedForConfig

    object

    As informações de configuração do campo XForward.

    XForwardedForGaIdEnabled

    boolean

    Indica se o campo de cabeçalho GA-ID é usado para recuperar o ID da instância do Alibaba Cloud Global Accelerator (GA).

    • true: sim.

    • false: não.

    Nota

    Apenas listeners HTTP e HTTPS suportam este parâmetro.

    false
    XRealIpEnabled

    boolean

    Indica se o campo X-Real-IP é usado para recuperar o endereço IP real do cliente.

    • true: sim.

    • false: não.

    Nota

    Apenas listeners HTTP e HTTPS suportam este parâmetro.

    false
    XForwardedForGaApEnabled

    boolean

    Indica se o campo GA-AP é usado para recuperar as informações da área de aceleração.

    • true: sim.

    • false: não.

    Nota

    Apenas listeners HTTP e HTTPS suportam este parâmetro.

    false
    XForwardedForProtoEnabled

    boolean

    Indica se o campo GA-X-Forward-Proto é usado para recuperar o protocolo do listener da instância do Alibaba Cloud Global Accelerator (GA).

    • true: sim.

    • false: não.

    Nota

    Apenas listeners HTTP e HTTPS suportam este parâmetro.

    false
    XForwardedForPortEnabled

    boolean

    Indica se o campo GA-X-Forward-Port é usado para recuperar a porta do listener da instância do Alibaba Cloud Global Accelerator (GA).

    • true: sim.

    • false: não.

    Nota

    Apenas listeners HTTP e HTTPS suportam este parâmetro.

    false
    SecurityPolicyId

    string

    O ID da instância da política de segurança.

    • tls_cipher_policy_1_0

      • Versões TLS suportadas: TLSv1.0, TLSv1.1 e TLSv1.2.

      • Suítes de algoritmos de criptografia suportadas: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA e DES-CBC3-SHA.

    • tls_cipher_policy_1_1

      • Versões TLS suportadas: TLSv1.1 e TLSv1.2.

      • Suítes de algoritmos de criptografia suportadas: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA e DES-CBC3-SHA.

    • tls_cipher_policy_1_2

      • Versões TLS suportadas: TLSv1.2.

      • Suítes de algoritmos de criptografia suportadas: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA e DES-CBC3-SHA.

    • tls_cipher_policy_1_2_strict

      • Versões TLS suportadas: TLSv1.2.

      • Suítes de algoritmos de criptografia suportadas: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES128-SHA e ECDHE-RSA-AES256-SHA.

    • tls_cipher_policy_1_2_strict_with_1_3

      • Versões TLS suportadas: TLSv1.2 e TLSv1.3.

      • Suítes de algoritmos de criptografia suportadas: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256, TLS_AES_128_CCM_8_SHA256, ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA e ECDHE-RSA-AES256-SHA.

    Nota

    Apenas listeners HTTPS suportam este parâmetro.

    tls_cipher_policy_1_0
    Type

    string

    O tipo de roteamento do listener.

    • Standard: tipo de roteamento inteligente.

    • CustomRouting: tipo de roteamento personalizado.

    Standard
    ServiceId

    string

    O ID do serviço ao qual a instância gerenciada pertence.

    Nota

    Este parâmetro é válido apenas quando ServiceManaged é definido como True.

    ALB
    ServiceManaged

    boolean

    Indica se a instância é gerenciada. Valores válidos:

    • true: A instância é gerenciada.

    • false: A instância não é gerenciada.

    true
    ServiceManagedInfos

    array<object>

    A lista de políticas de ação que o usuário pode executar na instância gerenciada.

    Nota

    • Este parâmetro é válido apenas quando ServiceManaged é definido como True.

    • Quando a instância está em um estado gerenciado, as operações do usuário na instância são restritas e certas ações são proibidas.

    object

    A lista de políticas de ação que o usuário pode executar na instância gerenciada.

    Action

    string

    O nome da ação da política gerenciada. Valores válidos:

    • Create: Criar uma instância.

    • Update: Atualizar a instância atual.

    • Delete: Excluir a instância atual.

    • Associate: Referenciar ou ser referenciado pela instância atual.

    • UserUnmanaged: Retirar o gerenciamento da instância pelo usuário.

    • CreateChild: Criar um recurso filho sob a instância atual.

    Update
    ChildType

    string

    O tipo de recurso filho. Valores válidos:

    • Listener: recurso de listener.

    • IpSet: recurso de região de aceleração.

    • EndpointGroup: recurso de grupo de endpoints.

    • ForwardingRule: recurso de regra de encaminhamento.

    • Endpoint: recurso de endpoint.

    • EndpointGroupDestination: recurso de mapeamento de protocolo do grupo de endpoints sob um listener de roteamento personalizado.

    • EndpointPolicy: recurso de política de tráfego de endpoint sob um listener de roteamento personalizado.

    Nota

    Este parâmetro é válido apenas quando Action é definido como CreateChild.

    Listener
    IsManaged

    boolean

    Indica se a ação da política gerenciada é gerenciada. Valores válidos:

    • true: A ação da política gerenciada é gerenciada. O usuário não pode executar a ação especificada por Action na instância gerenciada.

    • false: A ação da política gerenciada não é gerenciada. O usuário pode executar a ação especificada por Action na instância gerenciada.

    false
    IdleTimeout

    integer

    O período de tempo limite de conexão ociosa. Unidade: segundos.

    900
    RequestTimeout

    integer

    O período de tempo limite de solicitação de conexão HTTP/HTTPS. Unidade: segundos.

    Nota

    Este parâmetro é válido apenas para listeners cujo Protocol (tipo de protocolo de transporte) é HTTP ou HTTPS. Se o servidor de backend não retornar uma resposta dentro do período de tempo limite, o Global Accelerator para de aguardar e retorna um código de erro HTTP 504 ao cliente.

    60
    HttpVersion

    string

    A versão máxima do protocolo HTTP. Valores válidos:

    • http3: HTTP/3.

    • http2: HTTP/2.

    • http1.1: HTTP/1.1.

    Nota

    Apenas listeners HTTPS suportam este parâmetro.

    http2
    PageSize

    integer

    O número de entradas por página para uma consulta paginada.

    10
    RequestId

    string

    O ID da solicitação.

    6FEA0CF3-D3B9-43E5-A304-D217037876A8
    PageNumber

    integer

    O número da página da lista.

    1

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "TotalCount": 1,
  "Listeners": [
    {
      "Certificates": [
        {
          "Type": "Server",
          "Id": "44983xxxx-cn-hangzhou"
        }
      ],
      "BackendPorts": [
        {
          "FromPort": "80",
          "ToPort": "80"
        }
      ],
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "Description": "Listener",
      "State": "active",
      "ClientAffinity": "SOURCE_IP",
      "Protocol": "TCP",
      "CreateTime": 1577786252000,
      "PortRanges": [
        {
          "FromPort": 20,
          "ToPort": 20
        }
      ],
      "Name": "Listener",
      "ProxyProtocol": true,
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "XForwardedForConfig": {
        "XForwardedForGaIdEnabled": false,
        "XRealIpEnabled": false,
        "XForwardedForGaApEnabled": false,
        "XForwardedForProtoEnabled": false,
        "XForwardedForPortEnabled": false
      },
      "SecurityPolicyId": "tls_cipher_policy_1_0",
      "Type": "Standard",
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ],
      "IdleTimeout": 900,
      "RequestTimeout": 60,
      "HttpVersion": "http2"
    }
  ],
  "PageSize": 10,
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "PageNumber": 1
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    500 UnknownError An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.