Todos os produtos
Search
Central de documentação

Resource Orchestration Service:ALIYUN::ALB::HealthCheckTemplate

Última atualização: Jun 27, 2026

O tipo de recurso ALIYUN::ALB::HealthCheckTemplate cria um modelo de verificação de integridade.

Sintaxe

{
  "Type": "ALIYUN::ALB::HealthCheckTemplate",
  "Properties": {
    "HealthCheckInterval": Integer,
    "HealthCheckConnectPort": Integer,
    "HealthCheckCodes": List,
    "UnhealthyThreshold": Integer,
    "HealthCheckMethod": String,
    "HealthCheckPath": String,
    "HealthCheckTemplateName": String,
    "HealthCheckHost": String,
    "HealthyThreshold": Integer,
    "HealthCheckProtocol": String,
    "HealthCheckTimeout": Integer,
    "HealthCheckHttpVersion": String,
    "ResourceGroupId": String
  }
}

Propriedades

Nome da propriedade

Tipo

Obrigatório

Atualizável

Descrição

Restrição

HealthCheckTemplateName

String

Sim

Sim

Nome do modelo de verificação de integridade.

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

HealthCheckCodes

List

Não

Sim

Códigos de status HTTP que indicam um servidor backend íntegro.

Valores válidos:

  • Se HealthCheckProtocol for HTTP, os valores válidos são http_2xx (padrão), http_3xx, http_4xx e http_5xx. Separe vários códigos de status com vírgulas (,).

  • Se HealthCheckProtocol for gRPC, os valores válidos são inteiros de 0 a 99. O valor padrão é 0. É possível especificar até 20 intervalos. Separe vários intervalos com vírgulas (,).

Nota

Esta propriedade só tem efeito quando HealthCheckProtocol é HTTP ou gRPC.

HealthCheckConnectPort

Integer

Não

Sim

Porta usada para verificações de integridade.

Valores válidos: 0 a 65535. Valor padrão: 0, o que significa que a verificação de integridade usa a porta do servidor backend.

HealthCheckHost

String

Não

Sim

Nome de domínio usado para verificações de integridade.

Valor padrão: $SERVER_IP.

O nome de domínio deve ter de 1 a 80 caracteres e atender aos seguintes requisitos:

  • Caracteres válidos: letras minúsculas, dígitos, hifens (-) e pontos (.).

  • Deve conter pelo menos um ponto (.). O ponto não pode aparecer no início ou no fim.

  • O rótulo mais à direita deve conter apenas letras, sem dígitos ou hifens (-).

  • Nos demais rótulos, os hifens (-) não podem aparecer no início ou no fim.

Nota

Esta propriedade só tem efeito quando HealthCheckProtocol é HTTP.

HealthCheckHttpVersion

String

Não

Não

Versão do HTTP usada para verificações de integridade.

Valores válidos:

  • HTTP1.0

  • HTTP1.1

HealthCheckInterval

Integer

Não

Sim

Intervalo entre verificações de integridade.

Valores válidos: 1 a 50.

Valor padrão: 2.

Unidade: segundos.

HealthCheckMethod

String

Não

Sim

Método usado para verificações de integridade.

Valores válidos:

  • HEAD (padrão): usado por padrão para listeners HTTP.

  • POST: usado por padrão para listeners gRPC.

  • GET: se a mensagem de resposta exceder 8 KB, ela será truncada. Isso não afeta o resultado da verificação de integridade.

Nota

Esta propriedade só tem efeito quando HealthCheckProtocol é HTTP ou gRPC.

HealthCheckPath

String

Não

Sim

URL usada para verificações de integridade.

A URL deve ter de 1 a 80 caracteres e começar com uma barra (/). Caracteres válidos incluem letras, dígitos, hifens (-), barras (/), pontos (.), sinais de porcentagem (%), pontos de interrogação (?), cerquilhas (#), e comerciais (&) e caracteres estendidos como _;~!() *[]@$^:',+ .

Nota

Esta propriedade só tem efeito quando HealthCheckProtocol é HTTP.

HealthCheckProtocol

String

Não

Sim

Protocolo usado para verificações de integridade.

Valores válidos:

  • HTTP (padrão): envia requisições HEAD ou GET para simular acesso de navegador e verificar se a aplicação do servidor está íntegra.

  • TCP: envia mensagens de handshake SYN para verificar se a porta do servidor está ativa.

  • gRPC: envia requisições POST ou GET para verificar se a aplicação do servidor está íntegra.

HealthCheckTimeout

Integer

Não

Sim

Tempo de espera por uma resposta da verificação de integridade.

Se o servidor backend não responder corretamente dentro desse tempo, a verificação de integridade falhará.

Valores válidos: 1 a 300.

Valor padrão: 5.

Unidade: segundos.

Nota

Se HealthCheckTimeout for menor que HealthCheckInterval, HealthCheckTimeout será ignorado e o timeout assumirá o valor de HealthCheckInterval.

HealthyThreshold

Integer

Não

Sim

Número de verificações de integridade bem-sucedidas consecutivas necessárias para alterar o status de um servidor backend de falha para íntegro.

Valores válidos: 2 a 10.

Valor padrão: 3.

ResourceGroupId

String

Não

Não

ID do grupo de recursos.

Nenhuma.

UnhealthyThreshold

Integer

Não

Sim

Número de verificações de integridade com falha consecutivas necessárias para alterar o status de um servidor backend de íntegro para não íntegro.

Valores válidos: 2 a 10.

Valor padrão: 3.

Valores de retorno

Fn::GetAtt

HealthCheckTemplateId: o ID do modelo de verificação de integridade.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  HealthCheckTemplateName:
    Type: String
    Description: |-
      The name of the health check template.
      The name must be 2 to 128 characters in length, and can contain letters, digits, periods
      (.), underscores (_), and hyphens (-). The name must start with a letter.
Resources:
  HealthCheckTemplate:
    Type: ALIYUN::ALB::HealthCheckTemplate
    Properties:
      HealthCheckTemplateName:
        Ref: HealthCheckTemplateName
Outputs:
  HealthCheckTemplateId:
    Description: The ID of the health check template.
    Value:
      Fn::GetAtt:
        - HealthCheckTemplate
        - HealthCheckTemplateId
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "HealthCheckTemplateName": {
      "Type": "String",
      "Description": "The name of the health check template.\nThe name must be 2 to 128 characters in length, and can contain letters, digits, periods\n(.), underscores (_), and hyphens (-). The name must start with a letter."
    }
  },
  "Resources": {
    "HealthCheckTemplate": {
      "Type": "ALIYUN::ALB::HealthCheckTemplate",
      "Properties": {
        "HealthCheckTemplateName": {
          "Ref": "HealthCheckTemplateName"
        }
      }
    }
  },
  "Outputs": {
    "HealthCheckTemplateId": {
      "Description": "The ID of the health check template.",
      "Value": {
        "Fn::GetAtt": [
          "HealthCheckTemplate",
          "HealthCheckTemplateId"
        ]
      }
    }
  }
}