DescribeListener - Global Accelerator: Central de Documentação do Alibaba Cloud

Descreve as configurações de um listener específico.

Descrição da operação

Esta operação consulta a configuração de um listener especificado, como seu tipo de roteamento, status, carimbo de data e hora de criação e informações de porta.

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

get

*Listener

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região onde a instância do Alibaba Cloud Global Accelerator (GA) está implantada. Defina o valor como cn-hangzhou.	cn-hangzhou
ListenerId	string	Sim	O ID do listener que você deseja consultar.	lsr-bp1bpn0kn908w4nbw****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações retornadas.
Description	string	A descrição do listener.	Listener
RequestId	string	O ID da solicitação.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
State	string	O status do listener. configuring: O listener está sendo configurado. init: O listener está sendo inicializado. updating: O listener está sendo atualizado. deleting: O listener está sendo excluído.	active
CreateTime	string	O carimbo de data e hora que indica 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	O início do intervalo de portas do listener usado para receber e encaminhar solicitações para endpoints.	20
ToPort	integer	O fim do intervalo de portas do listener usado para receber e encaminhar solicitações para endpoints.	20
BackendPorts	array<object>	As informações de porta de backend.
	object	O intervalo de portas de backend.
FromPort	string	A porta inicial do servidor de backend usada para receber solicitações. Este parâmetro é retornado apenas quando o protocolo do listener é HTTPS e a porta do listener é igual à porta de serviço do servidor de backend.	80
ToPort	string	A porta final do servidor de backend usada para receber solicitações.	80
Certificates	array<object>	A lista de certificados SSL.
	object	A lista de certificados SSL.
Type	string	O tipo do certificado. Apenas Server é retornado, o que indica um certificado do lado do servidor.	Server
Id	string	O ID do certificado SSL.	449****-cn-hangzhou
Protocol	string	O protocolo de transporte de rede usado pelo listener. TCP: TCP. UDP: UDP. HTTP: HTTP. HTTPS: HTTPS.	TCP
ListenerId	string	O ID do listener.	lsr-bp1bpn0kn908w4nbw****
ClientAffinity	string	Afinidade do cliente. Se NONE for retornado, a afinidade do cliente estará desativada. Nesse caso, as solicitações do mesmo cliente podem ser encaminhadas para endpoints diferentes. Se SOURCE_IP for retornado, a afinidade do cliente estará ativada. Quando um cliente acessa um aplicativo com estado, todas as solicitações do mesmo cliente são encaminhadas para o mesmo endpoint, independentemente da porta ou protocolo de origem.	SOURCE_IP
Name	string	O nome do listener.	Listener
RelatedAcls	array<object>	Os grupos de políticas de controle de acesso associados ao listener.
	object	Os grupos de políticas de controle de acesso associados ao listener.
AclId	string	O ID da lista de controle de acesso (ACL) associada ao listener.	123
Status	string	Indica se o recurso de controle de acesso está ativado. Associated: O recurso de controle de acesso está ativado.	Associated
AclType	string	O tipo da ACL. white: uma lista de permissões. Apenas solicitações dos endereços IP ou blocos CIDR na ACL são encaminhadas. Listas de permissões são adequadas para aplicativos que permitem acesso apenas de endereços IP específicos. Se você ativar uma lista de permissões, mas não adicionar um endereço IP à ACL, o listener do GA não encaminhará solicitações. black: uma lista de bloqueios. Todas as solicitações dos endereços IP ou blocos CIDR na ACL são negadas. Listas de bloqueios são adequadas para aplicativos que negam acesso de endereços IP específicos. Se você ativar uma lista de bloqueios, mas não adicionar um endereço IP à ACL, o listener do GA encaminhará todas as solicitações. Este parâmetro é retornado quando uma ACL está associada ao listener.	white
AcceleratorId	string	O ID da instância do GA.	ga-bp1odcab8tmno0hdq****
ProxyProtocol `deprecated`	boolean	Indica se o protocolo de proxy é usado para preservar os endereços IP dos clientes. true: O protocolo de proxy é usado para preservar os endereços IP dos clientes. Após a ativação deste recurso, você pode visualizar os endereços IP originais dos clientes no serviço de backend. false: O protocolo de proxy não é usado para preservar os endereços IP dos clientes.	false
XForwardedForConfig	object	As configurações dos cabeçalhos X-Forwarded-For.
XForwardedForGaIdEnabled	boolean	Indica se o cabeçalho GA-ID é usado para recuperar o ID da instância do GA. true: sim. false: não. Nota Este parâmetro está disponível apenas para listeners HTTP e HTTPS.	false
XForwardedForGaApEnabled	boolean	Indica se o cabeçalho GA-AP é usado para recuperar informações sobre a região de aceleração. true: sim. false: não. Nota Este parâmetro está disponível apenas para listeners HTTP e HTTPS.	false
XForwardedForProtoEnabled	boolean	Indica se o cabeçalho GA-X-Forward-Proto é usado para recuperar o protocolo do listener da instância do GA. true: sim. false: não. Nota Este parâmetro está disponível apenas para listeners HTTP e HTTPS.	false
XForwardedForPortEnabled	boolean	Indica se o cabeçalho GA-X-Forward-Port é usado para recuperar a porta do listener da instância do GA. true: sim. false: não. Nota Este parâmetro está disponível apenas para listeners HTTP e HTTPS.	false
XRealIpEnabled	boolean	Indica se o cabeçalho X-Real-IP é usado para recuperar os endereços IP reais dos clientes. true: sim. false: não. Nota Este parâmetro está disponível apenas para listeners HTTP e HTTPS.	false
SecurityPolicyId	string	O ID da política de segurança. tls_cipher_policy_1_0 Versões TLS suportadas: TLS 1.0, TLS 1.1 e TLS 1.2. Suítes 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: TLS 1.1 e TLS 1.2. Suítes 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: TLS 1.2. Suítes 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: TLS 1.2. Suítes 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: TLS 1.2 e TLS 1.3. Suítes 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 Este parâmetro está disponível apenas para listeners HTTPS.	tls_cipher_policy_1_0
Type	string	O tipo de roteamento do listener. Standard: roteamento inteligente. CustomRouting: roteamento personalizado.	Standard
ServiceId	string	O ID do serviço que gerencia a instância. Nota Este parâmetro é retornado apenas quando ServiceManaged está definido como True.	ALB
ServiceManaged	boolean	Indica se a instância é uma instância gerenciada. Valores válidos: true: A instância é uma instância gerenciada. false: A instância não é uma instância gerenciada.	true
ServiceManagedInfos	array<object>	As ações que você pode executar na instância gerenciada. Nota Este parâmetro é retornado apenas quando ServiceManaged está definido como True. Quando a instância está em um estado gerenciado, você não pode executar algumas operações na instância.
	object	As ações que você pode executar na instância gerenciada.
Action	string	O nome da ação na instância gerenciada. Valores válidos: Create: Criar uma instância. Update: Atualizar a instância atual. Delete: Excluir a instância atual. Associate: Associar a instância a outros recursos. UserUnmanaged: Retirar o gerenciamento da instância. CreateChild: Criar um recurso filho na instância.	Update
ChildType	string	O tipo do recurso filho. Valores válidos: Listener: listener. IpSet: região de aceleração. EndpointGroup: grupo de endpoints. ForwardingRule: regra de encaminhamento. Endpoint: endpoint. EndpointGroupDestination: mapeamento de protocolo de um grupo de endpoints associado a um listener de roteamento personalizado. EndpointPolicy: política de tráfego de um endpoint associado a um listener de roteamento personalizado. Nota Este parâmetro é retornado apenas quando Action está definido como CreateChild.	Listener
IsManaged	boolean	Indica se a ação especificada é gerenciada. Valores válidos: true: A ação especificada é gerenciada. Você não pode executar a ação especificada na instância gerenciada. false: A ação especificada não é gerenciada. Você pode executar a ação especificada na instância gerenciada.	false
IdleTimeout	integer	O período de tempo limite para conexões ociosas. Unidade: segundos.	900
RequestTimeout	integer	O período de tempo limite para solicitações HTTP ou HTTPS. Unidade: segundos. Nota Este parâmetro está disponível apenas para listeners HTTP e HTTPS. Se um servidor de backend não responder dentro do período de tempo limite, o GA retornará um 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 Este parâmetro está disponível apenas para listeners HTTPS.	http2

Exemplos

Resposta de sucesso

JSON formato

{
  "Description": "Listener",
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
  "State": "active",
  "CreateTime": "1577786252000",
  "PortRanges": [
    {
      "FromPort": 20,
      "ToPort": 20
    }
  ],
  "BackendPorts": [
    {
      "FromPort": "80",
      "ToPort": "80"
    }
  ],
  "Certificates": [
    {
      "Type": "Server",
      "Id": "449****-cn-hangzhou"
    }
  ],
  "Protocol": "TCP",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "ClientAffinity": "SOURCE_IP",
  "Name": "Listener",
  "RelatedAcls": [
    {
      "AclId": "123",
      "Status": "Associated"
    }
  ],
  "AclType": "white",
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ProxyProtocol": false,
  "XForwardedForConfig": {
    "XForwardedForGaIdEnabled": false,
    "XForwardedForGaApEnabled": false,
    "XForwardedForProtoEnabled": false,
    "XForwardedForPortEnabled": false,
    "XRealIpEnabled": 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"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	NotExist.Listener	listener %s is not exist	The listener %s does not exist.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	An error occurred while the request was being processed. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.