GetListenerAttribute - Server Load Balancer: Central de Documentação do Alibaba Cloud

Consulta os detalhes de um 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

alb:GetListenerAttribute

get

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

acs:ResourceTag

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ListenerId	string	Sim	O ID do listener.	lsn-o4u54y73wq7b******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes do listener.
AclConfig	object	As configurações das listas de controle de acesso (ACLs).
AclRelations	array<object>	Os IDs das ACLs associadas ao listener.
	object	A estrutura da ACL associada ao listener.
AclId	string	The ID of the ACL that is associated with the listener.	acl-doc****
Status	string	Indicates whether the ACL is associated with the listener. Valid values: Associating Associated Dissociating	Associating
AclType	string	O tipo da ACL. Valores válidos: White: uma whitelist. Apenas solicitações dos endereços IP ou blocos CIDR na ACL de rede são encaminhadas. Whitelists são aplicáveis a cenários em que você deseja permitir que apenas endereços IP específicos acessem um aplicativo. Seu serviço pode ser afetado negativamente se a whitelist não for configurada corretamente. Se uma whitelist for configurada para um listener, apenas as solicitações de endereços IP que estão na whitelist serão encaminhadas pelo listener. Se você ativar uma whitelist, mas não adicionar um endereço IP a ela, o listener encaminhará todas as solicitações. Black: uma blacklist. As solicitações dos endereços IP ou blocos CIDR na ACL de rede são negadas. Blacklists são adequadas para cenários em que você deseja negar o acesso de endereços IP ou blocos CIDR específicos a um aplicativo. Se uma blacklist for configurada para um listener, mas nenhum endereço IP for adicionado a ela, o listener encaminhará todas as solicitações.	White
Certificates	array<object>	Uma lista de certificados.
	object	As configurações do certificado.
CertificateId	string	O ID do certificado. Apenas certificados de servidor são suportados.	123157*******
CaCertificates	array<object>	Uma lista de certificados de CA padrão.
	object
CertificateId	string	O ID do certificado de CA padrão.	139a00*****
Status	string	O status do certificado.	Associated
IsDefault	boolean	Indica se o certificado é um certificado padrão. Valores válidos: true false	true
CaEnabled	boolean	Indica se a autenticação mútua está ativada. Valores válidos: true false	false
DefaultActions	array<object>	As ações da regra de encaminhamento padrão.
	array<object>	As configurações da regra de encaminhamento padrão.
ForwardGroupConfig	object	A configuração da ação ForwardGroup. Este parâmetro é retornado e entra em vigor quando Type é definido como ForwardGroup.
ServerGroupTuples	array<object>	The server group to which requests are forwarded.
	object	The server groups to which requests are forwarded.
ServerGroupId	string	The ID of the server group to which requests are forwarded.	sgp-i5qt20******
Type	string	O tipo da ação. Se ForwardGroup for retornado, as solicitações serão encaminhadas para vários grupos vServer.	ForwardGroup
GzipEnabled	boolean	Indica se a compactação GZIP está ativada para compactar tipos específicos de arquivos. Valores válidos: true false	true
Http2Enabled	boolean	Indica se o HTTP/2 está ativado. Valores válidos: true false Nota Este parâmetro está disponível apenas quando você cria um listener HTTPS.	true
IdleTimeout	integer	O período de tempo limite de uma conexão ociosa. Unidade: segundos. Se nenhuma solicitação for recebida dentro do período de tempo limite especificado, o Application Load Balancer (ALB) fecha a conexão atual. Quando uma solicitação é recebida, o ALB estabelece uma nova conexão.	2
ListenerDescription	string	O nome do listener.	HTTP_80
ListenerId	string	O ID do listener.	lsn-o4u54y73wq7b******
ListenerPort	integer	A porta de frontend usada pela instância ALB.	80
ListenerProtocol	string	O protocolo do listener. Valores válidos: HTTP, HTTPS e QUIC.	HTTP
ListenerStatus	string	O status do listener. Valores válidos: Provisioning Running Configuring Stopped	Running
LoadBalancerId	string	O ID da instância ALB.	alb-bd6oylbckp6k9x****
LogConfig	object	A configuração de log.
AccessLogRecordCustomizedHeadersEnabled	boolean	Indica se os cabeçalhos personalizados são registrados no log de acesso. Valores válidos: true false	true
AccessLogTracingConfig	object	A configuração do Xtrace. O Xtrace é usado para registrar solicitações enviadas ao ALB.
TracingEnabled	boolean	Indicates whether Xtrace is enabled. Valid values: true false Nota You can set this parameter to true only if the AccessLogEnabled parameter is set to true.	true
TracingSample	integer	The sampling rate of Xtrace. Valid values: 1 to 10000. Nota If TracingEnabled is set to true, this parameter is valid.	100
TracingType	string	The Xtrace type. Supported Xtrace type: Zipkin. Nota If TracingEnabled is set to true, this parameter is valid.	Zipkin
QuicConfig	object	As informações de configuração quando o listener está associado a um listener QUIC.
QuicListenerId	string	O ID do listener QUIC. Este parâmetro é retornado quando QuicUpgradeEnabled está definido como true. Apenas listeners HTTPS suportam este parâmetro. Nota Você deve associar o listener HTTPS e o listener QUIC à mesma instância ALB. Além disso, certifique-se de que o listener QUIC nunca tenha sido associado a outro listener.	lsn-ek6ad66t****
QuicUpgradeEnabled	boolean	Indica se o upgrade QUIC está ativado. Valores válidos: true false Nota Apenas listeners HTTPS suportam este parâmetro.	true
RequestId	string	O ID da solicitação.	365F4154-92F6-4AE4-92F8-7FF******
RequestTimeout	integer	O período de tempo limite de uma solicitação. Unidade: segundos. Se nenhuma resposta for recebida do servidor de backend dentro do período de tempo limite especificado, o ALB retorna um código de erro `HTTP 504` para o cliente.	34
SecurityPolicyId	string	A política de segurança. Nota Este parâmetro está disponível apenas quando você cria um listener HTTPS.	tls_cipher_policy_1_1
XForwardedForConfig	object	A configuração dos cabeçalhos XForward.
XForwardedForClientCertClientVerifyAlias	string	O nome do cabeçalho personalizado. Este parâmetro entra em vigor apenas quando XForwardedForClientCertClientVerifyEnabled está definido como true. O nome tem de 1 a 40 caracteres e pode conter letras minúsculas, hifens (-), sublinhados (_) e dígitos. Nota Este parâmetro está disponível apenas quando você cria um listener HTTPS.	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	Indica se o cabeçalho `X-Forwarded-Clientcert-clientverify` é usado para recuperar o resultado da verificação do certificado do cliente. Valores válidos: true false Nota Este parâmetro está disponível apenas quando você cria um listener HTTPS.	true
XForwardedForClientCertFingerprintAlias	string	O nome do cabeçalho personalizado. Este parâmetro entra em vigor apenas quando XForwardedForClientCertFingerprintEnabled está definido como true. O nome tem de 1 a 40 caracteres e pode conter letras minúsculas, hifens (-), sublinhados (_) e dígitos. Nota Este parâmetro está disponível apenas quando você cria um listener HTTPS.	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	Indica se o cabeçalho `X-Forwarded-Clientcert-fingerprint` é usado para recuperar a impressão digital do certificado do cliente. Valores válidos: true false Nota Este parâmetro está disponível apenas quando você cria um listener HTTPS.	true
XForwardedForClientCertIssuerDNAlias	string	O nome do cabeçalho personalizado. Este parâmetro entra em vigor apenas quando XForwardedForClientCertIssuerDNEnabled está definido como true. O nome tem de 1 a 40 caracteres e pode conter letras minúsculas, hifens (-), sublinhados (_) e dígitos. Nota Este parâmetro está disponível apenas quando você cria um listener HTTPS.	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	Indica se o cabeçalho `X-Forwarded-Clientcert-issuerdn` é usado para recuperar informações sobre a autoridade que emite o certificado do cliente. Valores válidos: true false Nota Este parâmetro está disponível apenas quando você cria um listener HTTPS.	true
XForwardedForClientCertSubjectDNAlias	string	O nome do cabeçalho personalizado. Este parâmetro entra em vigor apenas quando XForwardedForClientCertSubjectDNEnabled está definido como true. O nome tem de 1 a 40 caracteres e pode conter letras minúsculas, hifens (-), sublinhados (_) e dígitos. Nota Este parâmetro está disponível apenas quando você cria um listener HTTPS.	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	Indica se o cabeçalho `X-Forwarded-Clientcert-subjectdn` é usado para recuperar informações sobre o proprietário do certificado do cliente. Valores válidos: true false Nota Este parâmetro está disponível apenas quando você cria um listener HTTPS.	true
XForwardedForClientSrcPortEnabled	boolean	Indica se o cabeçalho `X-Forwarded-Client-Port` é usado para recuperar a porta do cliente. Valores válidos: true false Nota Este parâmetro está disponível apenas quando você cria um listener HTTP ou HTTPS.	true
XForwardedForEnabled	boolean	Indica se o cabeçalho `X-Forwarded-For` é usado para recuperar o endereço IP do cliente. Valores válidos: true (padrão) false Nota Se este parâmetro estiver definido como true, o valor padrão do parâmetro XForwardedForProcessingMode será append. Você pode alterá-lo para remove. Se este parâmetro estiver definido como false, o cabeçalho `X-Forwarded-For` na solicitação não será modificado de forma alguma antes de a solicitação ser enviada aos servidores de backend. Este parâmetro está disponível apenas para listeners HTTP e HTTPS.	true
XForwardedForProcessingMode	string	Especifica como o cabeçalho `X-Forwarded-For` é processado. Este parâmetro entra em vigor apenas quando XForwardedForEnabled está definido como true. Valores válidos: append (padrão) remove Nota Se este parâmetro estiver definido como append, o ALB anexa o endereço IP do último salto ao cabeçalho `X-Forwarded-For` existente na solicitação antes de a solicitação ser enviada aos servidores de backend. Se este parâmetro estiver definido como remove, o ALB remove o cabeçalho `X-Forwarded-For` na solicitação antes de a solicitação ser enviada aos servidores de backend, independentemente de a solicitação conter o cabeçalho `X-Forwarded-For`. Este parâmetro está disponível apenas para listeners HTTP e HTTPS.	append
XForwardedForProtoEnabled	boolean	Indica se o cabeçalho `X-Forwarded-Proto` é usado para recuperar o protocolo de escuta. Valores válidos: true false Nota Este parâmetro está disponível apenas quando você cria um listener HTTP, HTTPS ou QUIC.	true
XForwardedForSLBIdEnabled	boolean	Indica se o cabeçalho `SLB-ID` é usado para recuperar o ID da instância CLB. Valores válidos: true false Nota Este parâmetro está disponível apenas quando você cria um listener HTTP, HTTPS ou QUIC.	true
XForwardedForSLBPortEnabled	boolean	Indica se o cabeçalho `X-Forwarded-Port` é usado para recuperar a porta de escuta da instância ALB. Valores válidos: true false Nota Este parâmetro está disponível apenas quando você cria um listener HTTP, HTTPS ou QUIC.	true
XForwardedForClientSourceIpsEnabled	boolean	Indica se o cabeçalho `X-Forwarded-Client-Ip` é usado para recuperar a porta de origem da instância ALB. Valores válidos: true false Nota Este parâmetro está disponível apenas quando você cria um listener HTTP, HTTPS ou QUIC.	false
XForwardedForClientSourceIpsTrusted	string	O endereço IP do proxy confiável. O ALB percorre o `X-Forwarded-For` de trás para frente e seleciona o primeiro endereço IP que não está na lista de endereços IP confiáveis como o endereço IP real do cliente. O endereço IP é usado na limitação de endereço IP de origem.	10.1.1.0/24
XForwardedForHostEnabled	boolean	Especifica se o cabeçalho `X-Forwarded-Host` deve ser usado para recuperar o nome de domínio do cliente. Valores válidos: true false (padrão) Nota Este parâmetro está disponível para listeners HTTP, HTTPS e QUIC.	false
Tags	array<object>	As tags.
	object	As tags.
Key	string	A chave da tag. A chave da tag pode ter até 128 caracteres e não pode começar com `acs:` ou `aliyun`. Não pode conter `http://` ou `https://`.	env
Value	string	O valor da tag. O valor da tag pode ter até 128 caracteres e não pode começar com `acs:` ou `aliyun`. Não pode conter `http://` ou `https://`.	product

Exemplos

Resposta de sucesso

JSON formato

{
  "AclConfig": {
    "AclRelations": [
      {
        "AclId": "acl-doc****",
        "Status": "Associating"
      }
    ],
    "AclType": "White"
  },
  "Certificates": [
    {
      "CertificateId": "123157*******"
    }
  ],
  "CaCertificates": [
    {
      "CertificateId": "139a00*****",
      "Status": "Associated",
      "IsDefault": true
    }
  ],
  "CaEnabled": false,
  "DefaultActions": [
    {
      "ForwardGroupConfig": {
        "ServerGroupTuples": [
          {
            "ServerGroupId": "sgp-i5qt20******"
          }
        ]
      },
      "Type": "ForwardGroup"
    }
  ],
  "GzipEnabled": true,
  "Http2Enabled": true,
  "IdleTimeout": 2,
  "ListenerDescription": "HTTP_80",
  "ListenerId": "lsn-o4u54y73wq7b******",
  "ListenerPort": 80,
  "ListenerProtocol": "HTTP",
  "ListenerStatus": "Running",
  "LoadBalancerId": "alb-bd6oylbckp6k9x****",
  "LogConfig": {
    "AccessLogRecordCustomizedHeadersEnabled": true,
    "AccessLogTracingConfig": {
      "TracingEnabled": true,
      "TracingSample": 100,
      "TracingType": "Zipkin"
    }
  },
  "QuicConfig": {
    "QuicListenerId": "lsn-ek6ad66t****",
    "QuicUpgradeEnabled": true
  },
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******",
  "RequestTimeout": 34,
  "SecurityPolicyId": "tls_cipher_policy_1_1",
  "XForwardedForConfig": {
    "XForwardedForClientCertClientVerifyAlias": "test_client-verify-alias_123456",
    "XForwardedForClientCertClientVerifyEnabled": true,
    "XForwardedForClientCertFingerprintAlias": "test_finger-print-alias_123456",
    "XForwardedForClientCertFingerprintEnabled": true,
    "XForwardedForClientCertIssuerDNAlias": "test_issue-dn-alias_123456",
    "XForwardedForClientCertIssuerDNEnabled": true,
    "XForwardedForClientCertSubjectDNAlias": "test_subject-dn-alias_123456",
    "XForwardedForClientCertSubjectDNEnabled": true,
    "XForwardedForClientSrcPortEnabled": true,
    "XForwardedForEnabled": true,
    "XForwardedForProcessingMode": "append",
    "XForwardedForProtoEnabled": true,
    "XForwardedForSLBIdEnabled": true,
    "XForwardedForSLBPortEnabled": true,
    "XForwardedForClientSourceIpsEnabled": false,
    "XForwardedForClientSourceIpsTrusted": "10.1.1.0/24",
    "XForwardedForHostEnabled": false
  },
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	Forbidden.LoadBalancer	Authentication is failed for %s.	Authentication is failed for %s.
404	ResourceNotFound.Listener	The specified resource %s is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.