全部产品
Search
文档中心

Resource Orchestration Service:ALIYUN::ALB::HealthCheckTemplate

更新时间:Jun 26, 2025

ALIYUN::ALB::HealthCheckTemplate digunakan untuk membuat template pemeriksaan kesehatan.

Sintaksis

{
  "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
  }
}

Properti

Properti

Tipe

Diperlukan

Dapat Diedit

Deskripsi

Kendala

HealthCheckTemplateName

String

Ya

Ya

Nama dari template pemeriksaan kesehatan.

Nama harus memiliki panjang 2 hingga 128 karakter dan dapat berisi huruf, angka, titik (.), garis bawah (_), dan tanda hubung (-). Nama harus dimulai dengan huruf.

HealthCheckCodes

List

Tidak

Ya

Kode status HTTP untuk pemeriksaan kesehatan yang berhasil.

Nilai valid:

  • Nilai valid jika Anda menetapkan HealthCheckProtocol ke HTTP: http_2xx, http_3xx, http_4xx, dan http_5xx. Nilai default: http_2xx. Pisahkan beberapa kode status HTTP dengan koma (,).

  • Nilai valid jika Anda menetapkan HealthCheckProtocol ke gRPC: 0 hingga 99. Nilai default: 0. Rentang nilai didukung. Anda dapat menentukan hingga 20 rentang nilai. Pisahkan beberapa rentang nilai dengan koma (,).

Catatan

Properti ini hanya berlaku jika Anda menetapkan HealthCheckProtocol ke HTTP atau gRPC.

HealthCheckConnectPort

Integer

Tidak

Ya

Port yang ingin Anda gunakan untuk pemeriksaan kesehatan.

Nilai valid: 0 hingga 65535. Nilai default: 0. Nilai ini menentukan bahwa port server backend digunakan untuk pemeriksaan kesehatan.

HealthCheckHost

String

Tidak

Ya

Nama domain yang ingin Anda gunakan untuk pemeriksaan kesehatan.

Nilai default: $SERVER_IP.

Nama domain harus memiliki panjang 1 hingga 80 karakter. Nama domain harus memenuhi persyaratan berikut:

  • Nama domain dapat berisi huruf kecil, angka, tanda hubung (-), dan titik (.).

  • Nama domain dapat berisi setidaknya satu titik (.) tetapi tidak boleh dimulai atau diakhiri dengan titik (.).

  • Label domain paling kanan hanya dapat berisi huruf, dan tidak dapat berisi angka atau tanda hubung (-).

  • Label domain lainnya tidak boleh dimulai atau diakhiri dengan tanda hubung (-).

Catatan

Properti ini hanya berlaku jika Anda menetapkan HealthCheckProtocol ke HTTP.

HealthCheckInterval

Integer

Tidak

Ya

Interval waktu sistem melakukan pemeriksaan kesehatan.

Nilai valid: 1 hingga 50.

Nilai default: 2.

Unit: detik.

HealthCheckMethod

String

Tidak

Ya

Metode yang ingin Anda gunakan untuk pemeriksaan kesehatan.

Nilai valid:

  • HEAD: Secara default, pemeriksaan kesehatan HTTP menggunakan metode HEAD.

  • POST: Secara default, pemeriksaan kesehatan gRPC menggunakan metode POST.

  • GET: Jika panjang paket respons melebihi 8 KB, respons akan dipotong. Ini tidak memengaruhi hasil pemeriksaan kesehatan.

Catatan

Properti ini hanya berlaku jika Anda menetapkan HealthCheckProtocol ke HTTP atau gRPC.

HealthCheckPath

String

Tidak

Ya

URL yang ingin Anda gunakan untuk pemeriksaan kesehatan.

URL harus memiliki panjang 1 hingga 80 karakter dan dapat berisi huruf, angka, karakter khusus - / . % ? # & dan karakter tambahan _ ; ~ ! ( ) * [ ] @ $ ^ : ' , +. URL harus dimulai dengan garis miring (/).

Catatan

Properti ini hanya berlaku jika Anda menetapkan HealthCheckProtocol ke HTTP.

HealthCheckProtocol

String

Tidak

Ya

Protokol yang ingin Anda gunakan untuk pemeriksaan kesehatan.

Nilai valid:

  • HTTP: Sistem mengirimkan permintaan HEAD atau GET ke server backend untuk mensimulasikan akses dari browser dan memeriksa apakah server backend sehat.

  • TCP: Sistem mengirimkan paket SYN ke server backend untuk memeriksa apakah port server backend tersedia untuk menerima permintaan.

  • gRPC: Sistem mengirimkan permintaan POST atau GET ke server backend untuk memeriksa apakah server backend sehat.

HealthCheckTimeout

Integer

Tidak

Ya

Jangka waktu timeout untuk respons pemeriksaan kesehatan.

Jika server backend tidak mengembalikan respons pemeriksaan kesehatan dalam jangka waktu timeout yang ditentukan, server gagal dalam pemeriksaan kesehatan.

Nilai valid: 1 hingga 300.

Nilai default: 5.

Unit: detik.

Catatan

Jika nilai HealthCheckTimeout lebih kecil dari nilai HealthCheckInterval, periode timeout yang ditentukan oleh HealthCheckTimeout menjadi tidak valid, dan nilai HealthCheckInterval digunakan sebagai periode timeout.

HealthyThreshold

Integer

Tidak

Ya

Jumlah kali server backend yang tidak sehat harus lulus pemeriksaan kesehatan secara berturut-turut sebelum dinyatakan sehat. Ketika jumlah ini tercapai, status pemeriksaan kesehatan berubah dari gagal menjadi berhasil.

Nilai valid: 2 hingga 10.

Nilai default: 3.

UnhealthyThreshold

Integer

Tidak

Ya

Jumlah kali server backend yang sehat harus gagal dalam pemeriksaan kesehatan secara berturut-turut sebelum dinyatakan tidak sehat. Ketika jumlah ini tercapai, status pemeriksaan kesehatan berubah dari berhasil menjadi gagal.

Nilai valid: 2 hingga 10.

Nilai default: 3.

Nilai pengembalian

Fn::GetAtt

HealthCheckTemplateId: ID dari template pemeriksaan kesehatan.

Contoh

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  HealthCheckTemplateName:
    Type: String
    Description: |-
      Nama dari template pemeriksaan kesehatan.
      Nama harus memiliki panjang 2 hingga 128 karakter, dan dapat berisi huruf, angka, titik
      (.), garis bawah (_), dan tanda hubung (-). Nama harus dimulai dengan huruf.
Resources:
  HealthCheckTemplate:
    Type: ALIYUN::ALB::HealthCheckTemplate
    Properties:
      HealthCheckTemplateName:
        Ref: HealthCheckTemplateName
Outputs:
  HealthCheckTemplateId:
    Description: ID dari template pemeriksaan kesehatan.
    Value:
      Fn::GetAtt:
        - HealthCheckTemplate
        - HealthCheckTemplateId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "HealthCheckTemplateName": {
      "Type": "String",
      "Description": "Nama dari template pemeriksaan kesehatan.\nNama harus memiliki panjang 2 hingga 128 karakter, dan dapat berisi huruf, angka, titik\n(.), garis bawah (_), dan tanda hubung (-). Nama harus dimulai dengan huruf."
    }
  },
  "Resources": {
    "HealthCheckTemplate": {
      "Type": "ALIYUN::ALB::HealthCheckTemplate",
      "Properties": {
        "HealthCheckTemplateName": {
          "Ref": "HealthCheckTemplateName"
        }
      }
    }
  },
  "Outputs": {
    "HealthCheckTemplateId": {
      "Description": "ID dari template pemeriksaan kesehatan.",
      "Value": {
        "Fn::GetAtt": [
          "HealthCheckTemplate",
          "HealthCheckTemplateId"
        ]
      }
    }
  }
}