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	As informações detalhadas sobre o listener.
AclConfig	object	A estrutura de configuração de ACL.
AclRelations	array<object>	Os IDs das políticas de controle de acesso associadas ao listener.
	object	A estrutura das políticas de controle de acesso associadas ao listener.
AclId	string	O ID da política de controle de acesso associada ao listener.	acl-doc****
Status	string	O status da associação entre a ACL e o listener. Valores válidos: Associating: A ACL está sendo associada. Associated: A ACL está associada. Dissociating: A ACL está sendo desassociada.	Associating
AclType	string	O tipo de controle de acesso. Valores válidos: White: Apenas solicitações dos endereços IP ou blocos CIDR configurados na ACL selecionada são encaminhadas. Uma lista de permissões é aplicável a cenários em que um aplicativo permite acesso apenas de endereços IP específicos. Configurar uma lista de permissões apresenta riscos ao negócio. Após a configuração de uma lista de permissões, apenas solicitações dos endereços IP na lista de permissões podem acessar o listener de balanceamento de carga. Se você ativar o acesso por lista de permissões, mas não adicionar nenhum endereço IP à ACL, o listener de balanceamento de carga encaminhará todas as solicitações. Black: Nenhuma solicitação dos endereços IP ou blocos CIDR configurados na ACL selecionada é encaminhada. Uma lista de bloqueio é aplicável a cenários em que um aplicativo bloqueia o acesso de endereços IP específicos. Se você ativar o acesso por lista de bloqueio, mas não adicionar nenhum endereço IP à ACL, o listener de balanceamento de carga encaminhará todas as solicitações.	White
CaCertificates	array<object>	A lista de certificados de CA.
	object
CertificateId	string	O ID do certificado de CA.	139a00*****
IsDefault	boolean	Especifica se o certificado é o certificado padrão. Valores válidos: true: Sim. false: Não.	true
Status	string	O status do certificado.	Associated
CaEnabled	boolean	Especifica se a autenticação mútua está ativada. Valores válidos: true: Sim. false: Não.	false
Certificates	array<object>	A lista de certificados.
	object	A estrutura do certificado.
CertificateId	string	O ID do certificado. Apenas certificados de servidor são suportados.	123157*******
DefaultActions	array<object>	A lista de ações de regra padrão.
	array<object>	A estrutura da ação de regra padrão.
ForwardGroupConfig	object	A configuração da ação de encaminhamento. Este parâmetro entra em vigor apenas quando o tipo de ação é ForwardGroup.
ServerGroupTuples	array<object>	Os grupos de servidores de destino para encaminhamento.
	object	Os grupos de servidores de destino para encaminhamento.
ServerGroupId	string	O ID do grupo de servidores de destino.	sgp-i5qt20******
Type	string	O tipo de ação. Valor válido: ForwardGroup, que indica que as solicitações são encaminhadas para vários grupos de servidores.	ForwardGroup
GzipEnabled	boolean	Especifica se a compactação Gzip está ativada para compactar tipos de arquivo específicos. Valores válidos: true: Sim. false: Não.	true
Http2Enabled	boolean	Especifica se o HTTP/2 está ativado. Valores válidos: true: Sim. false: Não. Nota Este parâmetro é suportado apenas por listeners HTTPS.	true
IdleTimeout	integer	Especifica o período de tempo limite de conexão ociosa. Unidade: segundos. Se nenhuma solicitação for recebida dentro do período de tempo limite, o load balancer fecha temporariamente a conexão atual e estabelece uma nova conexão quando a próxima solicitação chegar.	2
ListenerDescription	string	O nome personalizado do listener.	HTTP_80
ListenerId	string	O ID do listener.	lsn-o4u54y73wq7b******
ListenerPort	integer	A porta de frontend usada pelo load balancer.	80
ListenerProtocol	string	O protocolo do listener. Valores válidos: HTTP, HTTPS e QUIC.	HTTP
ListenerStatus	string	O status atual do listener. Valores válidos: Provisioning: O listener está sendo criado. Running: O listener está em execução. Configuring: O listener está sendo configurado. Stopped: O listener está parado.	Running
LoadBalancerId	string	O ID da instância ALB.	alb-bd6oylbckp6k9x****
LogConfig	object	As informações de configuração de log.
AccessLogRecordCustomizedHeadersEnabled	boolean	Especifica se campos de cabeçalho personalizados estão incluídos nos logs de acesso. Valores válidos: true: Sim. false: Não.	true
AccessLogTracingConfig	object	As informações de configuração do Xtrace para logs de acesso.
TracingEnabled	boolean	O status do recurso Xtrace. Valores válidos: true: Sim. false: Não. Nota Você pode definir este parâmetro como true apenas quando o recurso de log de acesso (AccessLogEnabled) estiver ativado para a instância.	true
TracingSample	integer	A taxa de amostragem para o Xtrace. Valores válidos: 1 a 10000. Nota Este parâmetro entra em vigor apenas quando TracingEnabled é definido como true.	100
TracingType	string	O tipo de Xtrace. Valor válido: Zipkin. Nota Este parâmetro entra em vigor apenas quando TracingEnabled é definido como true.	Zipkin
QuicConfig	object	As informações de configuração para associar um listener QUIC.
QuicListenerId	string	O ID do listener QUIC a ser associado. Este parâmetro é obrigatório quando QuicUpgradeEnabled é definido como true. Este parâmetro entra em vigor apenas para listeners HTTPS. Nota O listener original e o listener QUIC associado devem pertencer à mesma instância ALB, e o listener QUIC não deve ter sido associado anteriormente.	lsn-ek6ad66t****
QuicUpgradeEnabled	boolean	Especifica se o upgrade QUIC está ativado. Valores válidos: true: Sim. false: Não. Nota Este parâmetro entra em vigor apenas para listeners HTTPS.	true
RequestId	string	O ID da solicitação.	365F4154-92F6-4AE4-92F8-7FF******
RequestTimeout	integer	Especifica o período de tempo limite da solicitação. Unidade: segundos. Se um servidor de backend não enviar uma resposta dentro do período de tempo limite, o load balancer para de esperar e retorna um código de erro `HTTP 504` para o cliente.	34
SecurityPolicyId	string	A política de segurança. Nota Este parâmetro é compatível apenas com listeners HTTPS.	tls_cipher_policy_1_1
Tags	array<object>	As tags.
	object	A estrutura da tag.
Key	string	A chave da tag. Pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	env
Value	string	O valor da tag. Pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	product
XForwardedForConfig	object	A configuração do campo X-Forwarded-For.
XForwardedForClientCertClientVerifyAlias	string	O nome do cabeçalho personalizado. Este parâmetro entra em vigor apenas quando XForwardedForClientCertClientVerifyEnabled é definido como true. O nome deve ter de 1 a 40 caracteres e pode conter letras minúsculas, hifens (-), sublinhados (_) e dígitos. Nota Este parâmetro é compatível apenas com listeners HTTPS.	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	Especifica se deve ser usado o campo de cabeçalho `X-Forwarded-Clientcert-clientverify` para obter o resultado da verificação do certificado de cliente que acessa a instância de load balancer. Valores válidos: true: Sim. false: Não. Nota Este parâmetro é compatível apenas com listeners HTTPS.	true
XForwardedForClientCertFingerprintAlias	string	O nome do cabeçalho personalizado. Este parâmetro entra em vigor apenas quando XForwardedForClientCertFingerprintEnabled é definido como true. O nome deve ter de 1 a 40 caracteres e pode conter letras minúsculas, hifens (-), sublinhados (_) e dígitos. Nota Este parâmetro é compatível apenas com listeners HTTPS.	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	Especifica se deve ser usado o campo de cabeçalho `X-Forwarded-Clientcert-fingerprint` para obter a impressão digital do certificado de cliente que acessa a instância de load balancer. Valores válidos: true: Sim. false: Não. Nota Este parâmetro é compatível apenas com listeners HTTPS.	true
XForwardedForClientCertIssuerDNAlias	string	O nome do cabeçalho personalizado. Este parâmetro entra em vigor apenas quando XForwardedForClientCertIssuerDNEnabled é definido como true. O nome deve ter de 1 a 40 caracteres e pode conter letras minúsculas, hifens (-), sublinhados (_) e dígitos. Nota Este parâmetro é compatível apenas com listeners HTTPS.	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	Especifica se deve ser usado o campo de cabeçalho `X-Forwarded-Clientcert-issuerdn` para obter as informações do emissor do certificado de cliente que acessa a instância de load balancer. Valores válidos: true: Sim. false: Não. Nota Este parâmetro é compatível apenas com listeners HTTPS.	true
XForwardedForClientCertSubjectDNAlias	string	O nome do cabeçalho personalizado. Este parâmetro entra em vigor apenas quando XForwardedForClientCertSubjectDNEnabled é definido como true. O nome deve ter de 1 a 40 caracteres e pode conter letras minúsculas, hifens (-), sublinhados (_) e dígitos. Nota Este parâmetro é compatível apenas com listeners HTTPS.	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	Especifica se deve ser usado o campo de cabeçalho `X-Forwarded-Clientcert-subjectdn` para obter as informações do titular do certificado de cliente que acessa a instância de load balancer. Valores válidos: true: Sim. false: Não. Nota Este parâmetro é compatível apenas com listeners HTTPS.	true
XForwardedForClientSourceIpsEnabled	boolean	Especifica se deve ser permitido que o Application Load Balancer (ALB) obtenha o endereço IP real do cliente a partir do campo de cabeçalho `X-Forwarded-For`. Valores válidos: true: Sim. false: Não. Nota Este parâmetro é compatível com listeners HTTP e HTTPS.	false
XForwardedForClientSourceIpsTrusted	string	Os endereços IP de proxy confiáveis. O Application Load Balancer (ALB) percorre o campo de cabeçalho `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. Este endereço IP é usado para limitação de taxa baseada no endereço IP de origem.	10.1.1.0/24
XForwardedForClientSrcPortEnabled	boolean	Especifica se deve ser usado o campo de cabeçalho `X-Forwarded-Client-Port` para obter a porta do cliente que acessa a instância de load balancer. Valores válidos: true: Sim. false: Não. Nota Este parâmetro é compatível com listeners HTTP e HTTPS.	true
XForwardedForEnabled	boolean	Especifica se deve ser usado o campo de cabeçalho `X-Forwarded-For` para obter o endereço IP real do cliente. Valores válidos: true (padrão): Sim. false: Não. Nota Se você definir este parâmetro como true, o valor padrão de XForwardedForProcessingMode será append, e você poderá alterá-lo para remove. Se você definir este parâmetro como false, o campo de cabeçalho `X-Forwarded-For` será retido sem processamento adicional antes que a solicitação seja encaminhada para o servidor de back-end. Este parâmetro é compatível com listeners HTTP e HTTPS.	true
XForwardedForHostEnabled	boolean	Especifica se deve ser usado o campo de cabeçalho `X-Forwarded-Host` para obter o nome de domínio do cliente que acessa a instância de load balancer. Valores válidos: true: Sim. false (padrão): Não. Nota Este parâmetro é compatível com listeners HTTP, HTTPS e QUIC.	false
XForwardedForProcessingMode	string	O modo de processamento para o campo de cabeçalho `X-Forwarded-For`. Este parâmetro entra em vigor apenas quando XForwardedForEnabled é definido como true. Valores válidos: append (padrão): Anexa o endereço IP do último salto ao campo de cabeçalho `X-Forwarded-For` antes que a solicitação seja encaminhada para o servidor de back-end. remove: Exclui o campo de cabeçalho `X-Forwarded-For` antes que a solicitação seja encaminhada para o servidor de back-end, independentemente de a solicitação conter o campo de cabeçalho `X-Forwarded-For`. Nota Se você definir este parâmetro como append, o endereço IP do último salto será adicionado ao campo de cabeçalho `X-Forwarded-For` antes que a solicitação seja encaminhada para o servidor de back-end. Se você definir este parâmetro como remove, o campo de cabeçalho `X-Forwarded-For` será excluído antes que a solicitação seja encaminhada para o servidor de back-end, independentemente de a solicitação conter o campo de cabeçalho `X-Forwarded-For`. Este parâmetro é compatível com listeners HTTP e HTTPS.	append
XForwardedForProtoEnabled	boolean	Especifica se deve ser usado o campo de cabeçalho `X-Forwarded-Proto` para obter o protocolo do listener da instância de load balancer. Valores válidos: true: Sim. false: Não. Nota Este parâmetro é compatível com listeners HTTP, HTTPS e QUIC.	true
XForwardedForSLBIdEnabled	boolean	Especifica se deve ser usado o campo de cabeçalho `SLB-ID` para obter o ID da instância de load balancer. Valores válidos: true: Sim. false: Não. Nota Este parâmetro é compatível com listeners HTTP, HTTPS e QUIC.	true
XForwardedForSLBPortEnabled	boolean	Especifica se deve ser usado o campo de cabeçalho `X-Forwarded-Port` para obter a porta do listener da instância de load balancer. Valores válidos: true: Sim. false: Não. Nota Este parâmetro é compatível com listeners HTTP, HTTPS e QUIC.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "AclConfig": {
    "AclRelations": [
      {
        "AclId": "acl-doc****",
        "Status": "Associating"
      }
    ],
    "AclType": "White"
  },
  "CaCertificates": [
    {
      "CertificateId": "139a00*****",
      "IsDefault": true,
      "Status": "Associated"
    }
  ],
  "CaEnabled": false,
  "Certificates": [
    {
      "CertificateId": "123157*******"
    }
  ],
  "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",
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ],
  "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,
    "XForwardedForClientSourceIpsEnabled": false,
    "XForwardedForClientSourceIpsTrusted": "10.1.1.0/24",
    "XForwardedForClientSrcPortEnabled": true,
    "XForwardedForEnabled": true,
    "XForwardedForHostEnabled": false,
    "XForwardedForProcessingMode": "append",
    "XForwardedForProtoEnabled": true,
    "XForwardedForSLBIdEnabled": true,
    "XForwardedForSLBPortEnabled": true
  }
}

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.	Falha na autenticação da operação de balanceamento de carga.
404	ResourceNotFound.Listener	The specified resource %s is not found.	O listener não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.