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

Cria um modelo de verificação de integridade em uma região especificada.

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

create

*HealthCheckTemplate.

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

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. Gere um valor de parâmetro em seu cliente para garantir que o valor seja exclusivo em diferentes solicitações. O parâmetro ClientToken aceita apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usará automaticamente o RequestId da solicitação de API como ClientToken. O RequestId de cada solicitação de API é exclusivo.	5A2CFF0E-5718-45B5-9D4D-70B******
HealthCheckTemplateName	string	Sim	O nome do modelo de verificação de integridade. O nome deve ter de 2 a 128 caracteres. Deve começar com uma letra, caractere chinês ou 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. Valor padrão: 0, o que indica que a porta do servidor de back-end é usada para verificações de integridade.	80
HealthCheckHost	string	Não	O nome de domínio usado para verificações de integridade. Valores válidos: $SERVER_IP: o IP privado do servidor de back-end. Se um endereço IP for especificado ou se este parâmetro não for especificado, o balanceamento de carga usará o IP privado do servidor de back-end como o nome de domínio para verificações de integridade. domain: O nome de domínio deve ter de 1 a 80 caracteres e pode conter apenas letras, dígitos, pontos (.) e hifens (-). Nota Este parâmetro entra em vigor apenas quando `HealthCheckProtocol` está definido como HTTP ou HTTPS.	$SERVER_IP
HealthCheckCodes	array	Não	A lista de códigos de status normais para verificações de integridade.	5
	string	Não	Os códigos de status HTTP normais para verificações de integridade. Quando HealthCheckProtocol está definido como HTTP ou HTTPS, os valores válidos de HealthCheckCodes são http_2xx (padrão), http_3xx, http_4xx e http_5xx. Separe vários códigos de status com vírgulas (,). Quando HealthCheckProtocol está definido como gRPC, os valores válidos de HealthCheckCodes variam de 0 a 99. Valor padrão: 0. Você pode especificar intervalos. Há suporte para no máximo 20 intervalos. Separe vários intervalos com vírgulas (,). Nota Este parâmetro está disponível apenas quando HealthCheckProtocol está definido como HTTP, HTTPS ou gRPC.	http_2xx
HealthCheckInterval	integer	Não	O intervalo entre as verificações de integridade. Valores válidos: 1 a 50. Unidade: segundos. Valor padrão: 2.	2
HealthCheckTimeout	integer	Não	O tempo limite para receber uma resposta de uma verificação de integridade. Se o servidor de back-end não responder dentro do tempo limite especificado, a verificação de integridade falhará. Valores válidos: 1 a 300. Unidade: segundos. Valor padrão: 5.	5
HealthCheckPath	string	Não	A URL usada para verificações de integridade. A URL deve ter de 1 a 80 caracteres e 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 está disponível apenas quando `HealthCheckProtocol` está definido como HTTP ou HTTPS.	/test/index.html
HealthCheckMethod	string	Não	O método de verificação de integridade. Valores válidos: HEAD (padrão): o método padrão para verificações de integridade de listeners HTTP e HTTPS. POST: o método padrão para verificações de integridade de listeners gRPC. GET: Se o comprimento da mensagem de resposta exceder 8 KB, a mensagem será truncada. No entanto, isso não afeta o resultado da verificação de integridade. Nota Este parâmetro está disponível apenas quando HealthCheckProtocol está 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): envia solicitações HEAD ou GET para simulação de acesso do navegador a fim de verificar se o aplicativo do servidor está íntegro. HTTPS: envia solicitações HEAD ou GET para simulação de acesso do navegador a fim de verificar se o aplicativo do servidor está íntegro. (Fornece criptografia de dados, tornando-o mais seguro que o HTTP.) TCP: envia mensagens de handshake SYN para verificar se a porta do servidor está ativa. gRPC: envia solicitações POST ou GET para verificar se o aplicativo do servidor está íntegro.	HTTP
HealthCheckHttpVersion	string	Não	A versão HTTP para verificações de integridade. Valores válidos: HTTP 1.0 e HTTP 1.1. Valor padrão: HTTP 1.1. Nota Este parâmetro está disponível apenas quando `HealthCheckProtocol` está definido como HTTP ou HTTPS.	HTTP 1.0
HealthyThreshold	integer	Não	O número de verificações de integridade bem-sucedidas consecutivas que devem ocorrer antes que o status de verificação de integridade de um servidor de back-end mude de Failed para Successful. 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 que devem ocorrer antes que o status de verificação de integridade de um servidor de back-end mude de Successful para Failed. Valores válidos: 2 a 10. Valor padrão: 3.	4
DryRun	boolean	Não	Especifica se deve ser realizada apenas uma pré-verificação da solicitação. Valores válidos: true: envia uma solicitação de pré-verificação sem criar o recurso. O sistema verifica se os parâmetros obrigatórios foram especificados, se o formato da solicitação é válido e se os limites do serviço foram atendidos. Se a solicitação falhar na pré-verificação, o erro correspondente será retornado. Se a solicitação passar na pré-verificação, o código de erro `DryRunOperation` será retornado. false (padrão): envia uma solicitação normal. Depois que a solicitação passar na pré-verificação, o código de status http_2xx será retornado e a operação será executada.	true
Tag	array<object>	Não	As tags.
	object	Não	A estrutura da tag.
Key	string	Não	A chave da tag. A chave 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	Não	O valor da tag. O valor pode ter até 128 caracteres e não pode começar com aliyun ou acs:. Não pode conter http:// ou https://.	product
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-atstuj3rtop****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O modelo de verificação de integridade.
HealthCheckTemplateId	string	O ID do modelo de verificação de integridade.	hct-pno8sisi******
RequestId	string	O ID da solicitação.	365F4154-92F6-4AE4-92F8-7FF34******

Exemplos

Resposta de sucesso

JSON formato

{
  "HealthCheckTemplateId": "hct-pno8sisi******",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34******"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	QuotaExceeded.HealthCheckTemplatesNum	The quota of %s is exceeded, usage %s/%s.	A cota %s foi excedida. O uso atual é %s e a cota é %s.
403	Forbidden.HealthCheckTemplate	Authentication has failed for HealthCheckTemplate.	Falha na autenticação do HealthCheckTemplate.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.