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

Atualiza os atributos de um listener, como o nome do listener e as ações padrão.

Descrição da operação

UpdateListenerAttribute é uma operação assíncrona. Depois que você envia uma solicitação, o sistema retorna um ID de solicitação e executa a tarefa em segundo plano. A configuração do listener não é atualizada imediatamente. Você pode chamar a operação para consultar o status de atualização do listener:

Se um listener estiver no estado Configuring, ele está sendo atualizado.
Se um listener estiver no estado Running, ele foi atualizado.

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

update

*LoadBalancer

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

*SecurityPolicy

acs:alb:{#regionId}:{#accountId}:securitypolicy/{#securitypolicyId}

*ServerGroup

acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ListenerId	string	Sim	O ID do listener do Application Load Balancer (ALB).	lsn-o4u54y73wq7b******
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. O token deve ser exclusivo entre as solicitações e pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usará o RequestId da solicitação como o ClientToken. O RequestId de cada solicitação de API pode ser diferente.	5A2CFF0E-5718-45B5-9D4D-70B******
DryRun	boolean	Não	Especifica se deve ser realizado um dry run. Valores válidos: true: realiza um dry run. O sistema verifica os parâmetros obrigatórios, o formato da solicitação e os limites do serviço. Se a solicitação falhar no dry run, uma mensagem de erro será retornada. Se a solicitação passar no dry run, o sistema retornará o código de erro DryRunOperation. false (padrão): realiza uma solicitação normal. Se a solicitação passar na verificação, o sistema retornará um código de status HTTP 2xx e executará a operação.	false
ListenerDescription	string	Não	O nome do listener. O nome deve ter de 2 a 256 caracteres e pode conter letras, dígitos, caracteres chineses, vírgulas (,), pontos (.), ponto e vírgulas (;), barras (/), arrobas (@), sublinhados (_) e hifens (-).	HTTP_80
RequestTimeout	integer	Não	O período de tempo limite da solicitação. Unidade: segundos. Valores válidos: 1 a 180. Se nenhuma resposta for recebida do servidor de back-end durante o período de tempo limite, o ALB enviará um código de erro HTTP 504 para o cliente.	3
IdleTimeout	integer	Não	O período de tempo limite de ociosidade. Unidade: segundos. Valores válidos: 1 a 60. Se nenhuma solicitação for recebida durante o período de tempo limite, o ALB fechará a conexão atual. Quando uma nova solicitação for recebida, o ALB estabelecerá uma nova conexão.	15
GzipEnabled	boolean	Não	Especifica se a compactação Gzip deve ser ativada para compactar tipos específicos de arquivos. Valores válidos: true false	true
Http2Enabled	boolean	Não	Especifica se o HTTP/2 deve ser ativado. Valores válidos: true false Nota Este parâmetro está disponível apenas para listeners HTTPS.	true
SecurityPolicyId	string	Não	A política de segurança. Políticas de segurança do sistema e políticas de segurança personalizadas são suportadas. Nota Este parâmetro está disponível apenas para listeners HTTPS.	tls_cipher_policy_1_0
CaEnabled	boolean	Não	Especifica se a autenticação mútua deve ser ativada. Valores válidos: true false	false
XForwardedForConfig	object	Não	A configuração do cabeçalho X-Forwarded-For.
XForwardedForClientCertClientVerifyAlias	string	Não	O nome do cabeçalho personalizado. Este parâmetro entra em vigor apenas quando XForwardedForClientCertClientVerifyEnabled está definido como true. O nome deve ter de 1 a 40 caracteres e pode conter letras, dígitos, sublinhados (_) e hifens (-). Nota Este parâmetro está disponível apenas para listeners HTTPS.	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	Não	Especifica se o cabeçalho X-Forwarded-Clientcert-Clientverify deve ser 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 para listeners HTTPS.	false
XForwardedForClientCertFingerprintAlias	string	Não	O nome do cabeçalho personalizado. Este parâmetro entra em vigor apenas quando XForwardedForClientCertFingerprintEnabled está definido como true. O nome deve ter de 1 a 40 caracteres e pode conter letras, dígitos, sublinhados (_) e hifens (-). Nota Este parâmetro está disponível apenas para listeners HTTPS.	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	Não	Especifica se o cabeçalho X-Forwarded-Clientcert-Fingerprint deve ser usado para recuperar a impressão digital do certificado do cliente. Valores válidos: true false Nota Este parâmetro está disponível apenas para listeners HTTPS.	false
XForwardedForClientCertIssuerDNAlias	string	Não	O nome do cabeçalho personalizado. Este parâmetro entra em vigor apenas quando XForwardedForClientCertIssuerDNEnabled está definido como true. O nome deve ter de 1 a 40 caracteres e pode conter letras, dígitos, sublinhados (_) e hifens (-). Nota Este parâmetro está disponível apenas para listeners HTTPS.	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	Não	Especifica se o cabeçalho X-Forwarded-Clientcert-Issuerdn deve ser usado para recuperar informações sobre o emissor do certificado do cliente. Valores válidos: true false Nota Este parâmetro está disponível apenas para listeners HTTPS.	false
XForwardedForClientCertSubjectDNAlias	string	Não	O nome do cabeçalho personalizado. Este parâmetro entra em vigor apenas quando XForwardedForClientCertSubjectDNEnabled está definido como true. O nome deve ter de 1 a 40 caracteres e pode conter letras, dígitos, sublinhados (_) e hifens (-). Nota Este parâmetro está disponível apenas para listeners HTTPS.	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	Não	Especifica se o cabeçalho X-Forwarded-Clientcert-Subjectdn deve ser 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 para listeners HTTPS.	false
XForwardedForClientSrcPortEnabled	boolean	Não	Especifica se o cabeçalho X-Forwarded-Client-Srcport deve ser usado para recuperar a porta do cliente. Valores válidos: true false Nota Este parâmetro está disponível para listeners HTTP e HTTPS.	false
XForwardedForEnabled	boolean	Não	Especifica se o cabeçalho X-Forwarded-For deve ser usado para recuperar o endereço IP real do cliente. Valores válidos: true (padrão) false Nota Se você definir este parâmetro como true, o valor padrão de XForwardedForProcessingMode será append. Você pode alterar o valor para remove. Se você definir este parâmetro como false, o cabeçalho X-Forwarded-For será preservado antes que a solicitação seja enviada para o serviço de back-end. Nenhum processamento extra é realizado. Este parâmetro está disponível para listeners HTTP e HTTPS.	true
XForwardedForProcessingMode	string	Não	O modo de processamento do cabeçalho X-Forwarded-For. Este parâmetro entra em vigor apenas quando XForwardedForEnabled está definido como true. Valores válidos: append (padrão): anexa um endereço IP. remove: exclui um endereço IP. Nota Se você definir este parâmetro como append, o endereço IP do último salto será adicionado ao cabeçalho X-Forwarded-For antes que a solicitação seja enviada para o serviço de back-end. Se você definir este parâmetro como remove, o cabeçalho X-Forwarded-For será excluído antes que a solicitação seja enviada para o serviço de back-end, independentemente de a solicitação conter ou não o cabeçalho X-Forwarded-For. Este parâmetro está disponível para listeners HTTP e HTTPS.	append
XForwardedForProtoEnabled	boolean	Não	Especifica se o cabeçalho X-Forwarded-Proto deve ser usado para recuperar o protocolo do listener da instância ALB. Valores válidos: true false Nota Este parâmetro está disponível para listeners HTTP, HTTPS e QUIC.	false
XForwardedForSLBIdEnabled	boolean	Não	Especifica se o cabeçalho SLB-ID deve ser usado para recuperar o ID da instância ALB. Valores válidos: true false Nota Este parâmetro está disponível para listeners HTTP, HTTPS e QUIC.	false
XForwardedForSLBPortEnabled	boolean	Não	Especifica se o cabeçalho X-Forwarded-Port deve ser usado para recuperar a porta do listener da instância ALB. Valores válidos: true false Nota Este parâmetro está disponível para listeners HTTP, HTTPS e QUIC.	false
XForwardedForClientSourceIpsEnabled	boolean	Não	Especifica se o ALB pode encontrar o endereço IP real do cliente a partir do cabeçalho X-Forwarded-For. Valores válidos: true false Nota Este parâmetro está disponível para listeners HTTP e HTTPS.	false
XForwardedForClientSourceIpsTrusted	string	Não	O endereço IP do proxy confiável. O ALB percorre o cabeçalho X-Forwarded-For do fim ao início. O ALB 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.	10.1.1.0/24
XForwardedForHostEnabled	boolean	Não	Especifica se o cabeçalho X-Forwarded-Host deve ser usado para recuperar o nome de domínio que o cliente usou para acessar a instância ALB. Valores válidos: true false (padrão) Nota Este parâmetro está disponível para listeners HTTP, HTTPS e QUIC.	false
QuicConfig	object	Não	A configuração de associação do listener QUIC.
QuicListenerId	string	Não	O ID do listener QUIC a ser associado. Este parâmetro é obrigatório se QuicUpgradeEnabled estiver definido como true. Este parâmetro está disponível apenas para listeners HTTPS. Nota O listener original e o listener QUIC associado devem pertencer à mesma instância ALB. O listener QUIC não deve estar associado a outro listener.	lsn-333
QuicUpgradeEnabled	boolean	Não	Especifica se a atualização QUIC deve ser ativada. Valores válidos: true false Nota Este parâmetro está disponível apenas para listeners HTTPS.	false
Certificates	array<object>	Não	Os certificados.
	object	Não	O certificado.
CertificateId	string	Não	O ID do certificado padrão. Você pode adicionar apenas um certificado de servidor padrão. Nota Este parâmetro é obrigatório se o protocolo do listener for HTTPS ou QUIC. Para adicionar mais certificados de servidor, chame a operação após criar o listener.	123157******
CaCertificates	array<object>	Não	Os certificados de CA. Você pode especificar apenas um certificado de CA.
	object	Não	O certificado de CA.
CertificateId	string	Não	O ID do certificado de CA. Nota Este parâmetro é obrigatório se CaEnabled estiver definido como true.	123359******
DefaultActions	array<object>	Não	As ações padrão para a regra de encaminhamento.
	array<object>	Não	A ação padrão.
ForwardGroupConfig	object	Não	A configuração da ação de encaminhamento. Este parâmetro é obrigatório e entra em vigor se Type estiver definido como ForwardGroup. Você pode especificar no máximo 20 ações de encaminhamento.
ServerGroupTuples	array<object>	Sim	O grupo de servidores para o qual as solicitações são encaminhadas.
	object	Não	O grupo de servidores.
ServerGroupId	string	Sim	The ID of the server group to which requests are forwarded.	sgp-i5qt20******
Type	string	Sim	O tipo de ação. Você pode especificar apenas um tipo de ação. Defina o valor como ForwardGroup. Isso encaminha solicitações para vários grupos de servidores.	ForwardGroup

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
JobId	string	O ID da tarefa assíncrona.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	O ID da solicitação.	365F4154-92F6-4AE4-92F8-7FF******

Exemplos

Resposta de sucesso

JSON formato

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	The business status of %s [%s] is incorrect.
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.
400	OperationDenied.CrossLoadBalancerQUICListener	The operation is not allowed because of %s.	The operation is not allowed because of %s.
400	ResourceAlreadyAssociated.Listener	The specified resource %s is already associated.	The specified resource %s is already associated.
400	OperationDenied.GRPCServerGroup	The operation is not allowed because of %s.
400	ResourceAlreadyAssociated.Certificate	The specified resource %s is already associated.
400	ResourceQuotaExceeded.SecurityPolicyAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.	The quota of %s is exceeded for resource %s. Usage: %s/%s.
400	ResourceQuotaExceeded.ServerGroupAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceQuotaExceeded.LoadBalancerServersNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceQuotaExceeded.ServerAddedNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	OperationDenied.ServerGroupProtocolNotSupport	The operation is not allowed because of ServerGroupProtocolNotSupport.	The operation is not allowed because the server group protocol is not supported.
400	UnsupportedFeature.FullTraceHttps	The feature of FullTraceHttps is not supported for current instance.
400	ResourceInConfiguring.Listener	The specified resource of %s is being configured, please try again later.	The specified resource of %s is being configured, please try again later.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.	The %s is mismatched for %s and %s.
400	InvalidParameter	Invalid parameter, please check the parameter input.	Invalid parameter, please check the parameter input.
400	OperationDenied.CACertificateCorrupted	The CA certificate is corrupted.	CA certificate is corrupted
403	Forbidden.LoadBalancer	Authentication is failed for %s.	Authentication is failed for %s.
404	ResourceNotFound.Listener	The specified resource %s is not found.
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.
404	ResourceNotFound.SecurityPolicy	The specified resource %s is not found.	The specified resource %s is not found.
404	ResourceNotFound.Certificate	The specified resource %s is not found.	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.