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

Atualiza os atributos de um modelo de verificação de integridade, como seu nome e protocolo de verificação de integridade.

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

update

*HealthCheckTemplate

acs:alb:{#regionId}:{#accountId}:healthchecktemplate/{#healthchecktemplateId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você deve gerar um valor exclusivo em seu cliente para cada solicitação. O token de cliente pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usará automaticamente o `RequestId` da solicitação como o `ClientToken`. O `RequestId` de cada solicitação é exclusivo.	5A2CFF0E-5718-45B5-9D4D-70B******
HealthCheckTemplateName	string	Não	O nome do modelo de verificação de integridade. O nome deve ter de 2 a 128 caracteres, começar com uma letra, um caractere chinês ou um dígito, e pode conter letras, caracteres chineses, dígitos, pontos (.), sublinhados (_), hifens (-) e espaços.	HealthCheckTemplate1
HealthCheckConnectPort	integer	Não	A porta usada para verificações de integridade. Valores válidos: 0 a 65535. O valor padrão é 0, o que significa que a verificação de integridade usa a porta do servidor de back-end.	80
HealthCheckHost	string	Não	O nome de domínio usado para verificações de integridade. Valores válidos: $SERVER_IP (padrão): O IP privado de um servidor de back-end. Se você especificar este valor ou deixar o parâmetro vazio, o serviço de balanceamento de carga usará o IP privado do servidor de back-end para verificações de integridade. domain: Um nome de domínio com 1 a 80 caracteres que pode conter letras, dígitos, pontos (.) e hifens (-). Nota Este parâmetro entra em vigor apenas quando o parâmetro `HealthCheckProtocol` é definido como HTTP ou HTTPS.	$SERVER_IP
HealthCheckCodes	array	Não	A lista de códigos de status que indicam um estado íntegro.	5
	string	Não	Os códigos de status HTTP que indicam um servidor de back-end íntegro. Se HealthCheckProtocol estiver definido como HTTP ou HTTPS, especifique um ou mais dos seguintes valores: http_2xx (padrão), http_3xx, http_4xx e http_5xx. Separe vários valores com vírgulas. Se HealthCheckProtocol estiver definido como gRPC, os códigos de status válidos estão no intervalo de 0 a 99. O valor padrão é 0. Você pode especificar até 20 intervalos, separados por vírgulas. Nota Este parâmetro entra em vigor apenas quando o parâmetro HealthCheckProtocol é definido como HTTP, HTTPS ou gRPC.	http_2xx
HealthCheckInterval	integer	Não	O intervalo entre as verificações de integridade, em segundos. Valores válidos: 1 a 50. Valor padrão: 2.	5
HealthCheckTimeout	integer	Não	O período de tempo limite, em segundos, para uma resposta de verificação de integridade. Uma verificação de integridade falha se um servidor de back-end não responder dentro desse período. Valores válidos: 1 a 300. Valor padrão: 5.	3
HealthCheckPath	string	Não	A URL usada para verificações de integridade. A URL deve ter de 1 a 80 caracteres. Pode conter letras, dígitos, hifens (-), barras (/), pontos (.), sinais de porcentagem (%), pontos de interrogação (?), cerquilhas (#), e comerciais (&) e os seguintes caracteres estendidos: `_;~!()[]@$^:',+`. A URL deve começar com uma barra (/). Nota* Este parâmetro entra em vigor apenas quando o parâmetro HealthCheckProtocol é definido como HTTP, HTTPS ou gRPC.	/test/index.html
HealthCheckMethod	string	Não	O método usado para verificações de integridade. Valores válidos: HEAD (padrão): O método padrão para verificações de integridade em listeners HTTP e HTTPS. GET: Se o corpo da resposta for maior que 8 KB, ele será truncado. Isso não afeta o resultado da verificação de integridade. POST: O método padrão para verificações de integridade em listeners gRPC. Nota Este parâmetro entra em vigor apenas quando o parâmetro HealthCheckProtocol é definido como HTTP, HTTPS ou gRPC.	HEAD
HealthCheckProtocol	string	Não	O protocolo usado para verificações de integridade. Valores válidos: HTTP (padrão): Verifica a integridade de um servidor de back-end enviando uma solicitação HTTP HEAD ou GET. HTTPS: Verifica a integridade de um servidor de back-end enviando uma solicitação HTTPS HEAD ou GET. O HTTPS é mais seguro que o HTTP porque criptografa os dados. TCP: Verifica se uma porta do servidor de back-end está acessível enviando um pacote TCP SYN. gRPC: Verifica a integridade de um servidor de back-end enviando uma solicitação POST ou GET.	HTTP
HealthCheckHttpVersion	string	Não	A versão HTTP usada para verificações de integridade. Valores válidos: HTTP1.0 e HTTP1.1. Valor padrão: HTTP1.1. Nota Este parâmetro entra em vigor apenas quando o parâmetro `HealthCheckProtocol` é definido como HTTP ou HTTPS.	HTTP1.0
HealthyThreshold	integer	Não	O número de verificações de integridade bem-sucedidas consecutivas necessárias para alterar o status de um servidor de back-end de não íntegro para íntegro. Valores válidos: 2 a 10. Valor padrão: 3.	4
UnhealthyThreshold	integer	Não	O número de verificações de integridade com falha consecutivas necessárias para alterar o status de um servidor de back-end de íntegro para não íntegro. Valores válidos: 2 a 10. Valor padrão: 3.	4
DryRun	boolean	Não	Especifica se deve ser realizado um dry run. Valores válidos: true: Realiza um dry run para verificar a solicitação. O sistema verifica os parâmetros obrigatórios, a sintaxe da solicitação e as restrições de negócios sem executar a operação. Se a solicitação for inválida, um erro será retornado. Se a solicitação for válida, o código de erro `DryRunOperation` será retornado. false (padrão): Envia uma solicitação normal. Se a solicitação for válida, um código de status HTTP 2xx será retornado e a operação será executada.	true
HealthCheckTemplateId	string	Sim	O ID do modelo de verificação de integridade.	hct-bp1qjwo61******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta à solicitação de atualização.
RequestId	string	O ID da solicitação.	365F4154-92F6-4AE4-92F8-7FF3******

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF3******"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IncorrectStatus.HealthCheckTemplate	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
403	Forbidden.HealthCheckTemplate	Authentication is failed for %s.	Authentication is failed for %s.
404	ResourceNotFound.HealthCheckTemplate	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.