Todos os produtos
Search

Este produto

    Server Load Balancer:CreateHealthCheckTemplate

    Central de documentação

    Server Load Balancer:CreateHealthCheckTemplate

    Última atualização: Jun 28, 2026

    Cria um modelo de health check 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 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ê pode gerar esse token, mas deve garantir que ele seja exclusivo entre as solicitações. O token pode conter apenas caracteres ASCII.

    Nota

    Se você não especificar este parâmetro, o sistema usará o RequestId da solicitação como o token de cliente. Cada solicitação de API tem um RequestId exclusivo.

    5A2CFF0E-5718-45B5-9D4D-70B******
    HealthCheckTemplateName

    string

    Sim

    O nome do modelo de health check.

    O nome deve ter de 2 a 128 caracteres, deve começar com uma letra, um dígito ou um caractere chinês e pode conter dígitos, pontos (.), sublinhados (_), hifens (-) e espaços.

    HealthCheckTemplate1
    HealthCheckConnectPort

    integer

    Não

    A porta usada para health checks.

    Valores válidos: 0 a 65535.

    Valor padrão: 0. Este valor indica que a porta de um servidor de back-end é usada para health checks.

    80
    HealthCheckHost

    string

    Não

    O nome de domínio usado para o health check. Valores válidos:

    • $SERVER_IP: O endereço IP privado de um servidor de back-end. Se você definir este parâmetro como $SERVER_IP ou deixá-lo vazio, o load balancer usará o endereço IP privado do servidor de back-end como o nome de domínio para o health check.

    • domain: O nome de domínio deve ter de 1 a 80 caracteres e 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

    Os códigos de status HTTP que indicam um health check bem-sucedido.

    5

    string

    Não

    Os códigos de status HTTP que indicam um health check bem-sucedido.

    • Se HealthCheckProtocol estiver definido como HTTP ou HTTPS, você pode especificar http_2xx (padrão), http_3xx, http_4xx e http_5xx. Você pode especificar vários códigos de status HTTP. Separe-os com vírgulas (,).

    • Se HealthCheckProtocol estiver definido como gRPC, os códigos de status válidos são de 0 a 99. O valor padrão é 0. Você pode especificar até 20 intervalos de valores. Separe-os com 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 em que os health checks são realizados.

    Valores válidos: 1 a 50. Unidade: segundos.

    Valor padrão: 2. Unidade: segundos.

    2
    HealthCheckTimeout

    integer

    Não

    O tempo limite para uma resposta de health check. Se um servidor de back-end não responder dentro desse período, o health check falhará.

    Valores válidos: 1 a 300. Unidade: segundos.

    Valor padrão: 5. Unidade: segundos.

    5
    HealthCheckPath

    string

    Não

    A URL usada para health checks.

    A URL deve ter de 1 a 80 caracteres. Deve começar com uma barra (/) e pode conter letras, dígitos e os seguintes caracteres especiais: - / . % ? # & _;~!()*[]@$^:',+.

    Nota

    Este parâmetro entra em vigor apenas quando o parâmetro HealthCheckProtocol é definido como HTTP ou HTTPS.

    /test/index.html
    HealthCheckMethod

    string

    Não

    O método usado para o health check. Valores válidos:

    • HEAD (padrão): Para listeners HTTP e HTTPS, o método padrão de health check é HEAD.

    • POST: Para listeners gRPC, o método padrão de health check é POST.

    • GET: Se o corpo da resposta exceder 8 KB, ele será truncado. Isso não afeta o resultado do health check.

    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 o health check. Valores válidos:

    • HTTP (padrão): simula o acesso do navegador enviando solicitações HEAD ou GET para verificar se o aplicativo do servidor está íntegro.

    • HTTPS: simula o acesso do navegador enviando solicitações HEAD ou GET para verificar se o aplicativo do servidor está íntegro. O HTTPS fornece transmissão de dados criptografados e é mais seguro que o HTTP.

    • TCP: verifica se a porta do servidor está responsiva enviando pacotes SYN.

    • gRPC: verifica se o aplicativo do servidor está íntegro enviando solicitações POST ou GET.

    HTTP
    HealthCheckHttpVersion

    string

    Não

    A versão do protocolo HTTP usada para o health check.

    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.

    HTTP 1.0
    HealthyThreshold

    integer

    Não

    O número de health checks bem-sucedidos consecutivos necessários para alterar o status de integridade de um servidor de back-end de unhealthy para healthy.

    Valores válidos: 2 a 10.

    Valor padrão: 3.

    4
    UnhealthyThreshold

    integer

    Não

    O número de health checks com falha consecutivos necessários para alterar o status de integridade de um servidor de back-end de healthy para unhealthy.

    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. O sistema verifica a solicitação quanto a possíveis problemas, incluindo parâmetros obrigatórios ausentes, sintaxe de solicitação incorreta e limites de 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 código de erro DryRunOperation será retornado. O recurso não é criado.

    • 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 o modelo de health check será criado.

    true
    Tag

    array<object>

    Não

    As tags.

    object

    Não

    As tags.

    Key

    string

    Não

    A chave da tag. A chave da tag pode ter até 128 caracteres. Não pode começar com aliyun ou acs: e não pode conter http:// ou https://.

    env
    Value

    string

    Não

    O valor da tag. O valor da tag pode ter até 128 caracteres. Não pode começar com aliyun ou acs: e 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 objeto do modelo de health check.

    HealthCheckTemplateId

    string

    O ID do modelo de health check.

    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. The quota of %s is exceeded. Usage: %s/%s.
    403 Forbidden.HealthCheckTemplate Authentication has failed for HealthCheckTemplate.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.