All Products
Search

This Product

    Server Load Balancer:CreateHealthCheckTemplate

    Document Center

    Server Load Balancer:CreateHealthCheckTemplate

    Last Updated:Jun 10, 2026

    Buat templat pemeriksaan kesehatan di wilayah yang ditentukan.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    alb:CreateHealthCheckTemplate

    create

    *HealthCheckTemplate

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ClientToken

    string

    No

    Token klien yang digunakan untuk memastikan idempotensi permintaan.

    Anda dapat membuat token ini, tetapi Anda harus memastikan bahwa token tersebut unik di seluruh permintaan. Token hanya dapat berisi karakter ASCII.

    Catatan

    Jika Anda tidak menentukan parameter ini, sistem menggunakan RequestId dari permintaan sebagai token klien. Setiap permintaan API memiliki RequestId yang unik.

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

    string

    Yes

    Nama templat pemeriksaan kesehatan.

    Panjang nama harus 2 hingga 128 karakter, harus dimulai dengan huruf, angka, atau karakter Mandarin, dan dapat berisi angka, titik (.), garis bawah (_), tanda hubung (-), dan spasi.

    HealthCheckTemplate1
    HealthCheckConnectPort

    integer

    No

    Port yang digunakan untuk pemeriksaan kesehatan.

    Nilai yang valid: 0 hingga 65535.

    Nilai default: 0. Nilai ini menunjukkan bahwa port server backend digunakan untuk pemeriksaan kesehatan.

    80
    HealthCheckHost

    string

    No

    Nama domain yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid:

    • $SERVER_IP: Alamat IP pribadi server backend. Jika Anda mengatur parameter ini ke $SERVER_IP atau membiarkannya kosong, load balancer akan menggunakan alamat IP pribadi server backend sebagai nama domain untuk pemeriksaan kesehatan.

    • domain: Panjang nama domain harus 1 hingga 80 karakter dan dapat berisi huruf, angka, titik (.), dan tanda hubung (-).

    Catatan

    Parameter ini hanya berlaku ketika parameter HealthCheckProtocol diatur ke HTTP atau HTTPS.

    $SERVER_IP
    HealthCheckCodes

    array

    No

    Kode status HTTP yang menunjukkan pemeriksaan kesehatan berhasil.

    5

    string

    No

    Kode status HTTP yang menunjukkan pemeriksaan kesehatan berhasil.

    • Jika HealthCheckProtocol diatur ke HTTP atau HTTPS, Anda dapat menentukan http_2xx (default), http_3xx, http_4xx, dan http_5xx. Anda dapat menentukan beberapa kode status HTTP. Pisahkan dengan koma (,).

    • Jika HealthCheckProtocol diatur ke gRPC, kode status yang valid adalah dari 0 hingga 99. Nilai default adalah 0. Anda dapat menentukan hingga 20 rentang nilai. Pisahkan dengan koma (,).

    Catatan

    Parameter ini hanya berlaku ketika parameter HealthCheckProtocol diatur ke HTTP, HTTPS, atau gRPC.

    http_2xx
    HealthCheckInterval

    integer

    No

    Interval saat pemeriksaan kesehatan dilakukan.

    Nilai yang valid: 1 hingga 50. Unit: detik.

    Nilai default: 2. Unit: detik.

    2
    HealthCheckTimeout

    integer

    No

    Periode timeout untuk respons pemeriksaan kesehatan. Jika server backend tidak merespons dalam periode ini, pemeriksaan kesehatan gagal.

    Nilai yang valid: 1 hingga 300. Unit: detik.

    Nilai default: 5. Unit: detik.

    5
    HealthCheckPath

    string

    No

    URL yang digunakan untuk pemeriksaan kesehatan.

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

    Catatan

    Parameter ini hanya berlaku ketika parameter HealthCheckProtocol diatur ke HTTP atau HTTPS.

    /test/index.html
    HealthCheckMethod

    string

    No

    Metode yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid:

    • HEAD (default): Untuk listener HTTP dan HTTPS, metode pemeriksaan kesehatan default adalah HEAD.

    • POST: Untuk listener gRPC, metode pemeriksaan kesehatan default adalah POST.

    • GET: Jika body respons melebihi 8 KB, body akan dipotong. Hal ini tidak memengaruhi hasil pemeriksaan kesehatan.

    Catatan

    Parameter ini hanya berlaku ketika parameter HealthCheckProtocol diatur ke HTTP, HTTPS, atau gRPC.

    HEAD
    HealthCheckProtocol

    string

    No

    Protokol yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid:

    • HTTP (default): mensimulasikan akses peramban dengan mengirim permintaan HEAD atau GET untuk memeriksa apakah aplikasi server sehat.

    • HTTPS: mensimulasikan akses peramban dengan mengirim permintaan HEAD atau GET untuk memeriksa apakah aplikasi server sehat. HTTPS menyediakan transmisi data terenkripsi dan lebih aman daripada HTTP.

    • TCP: memeriksa apakah port server responsif dengan mengirim paket SYN.

    • gRPC: memeriksa apakah aplikasi server sehat dengan mengirim permintaan POST atau GET.

    HTTP
    HealthCheckHttpVersion

    string

    No

    Versi protokol HTTP yang digunakan untuk pemeriksaan kesehatan.

    Nilai yang valid: HTTP1.0 dan HTTP1.1.

    Nilai default: HTTP1.1.

    Catatan

    Parameter ini hanya berlaku ketika parameter HealthCheckProtocol diatur ke HTTP atau HTTPS.

    HTTP 1.0
    HealthyThreshold

    integer

    No

    Jumlah pemeriksaan kesehatan berhasil berturut-turut yang diperlukan untuk mengubah status kesehatan server backend dari unhealthy menjadi healthy.

    Nilai yang valid: 2 hingga 10.

    Nilai default: 3.

    4
    UnhealthyThreshold

    integer

    No

    Jumlah pemeriksaan kesehatan gagal berturut-turut yang diperlukan untuk mengubah status kesehatan server backend dari healthy menjadi unhealthy.

    Nilai yang valid: 2 hingga 10.

    Nilai default: 3.

    4
    DryRun

    boolean

    No

    Menentukan apakah akan melakukan dry run. Nilai yang valid:

    • true: Melakukan dry run. Sistem memeriksa permintaan untuk masalah potensial, termasuk parameter wajib yang hilang, sintaks permintaan yang salah, dan batas layanan. Jika permintaan gagal pada dry run, pesan kesalahan dikembalikan. Jika permintaan lulus dry run, kode kesalahan DryRunOperation dikembalikan. Resource tidak dibuat.

    • false (default): Mengirim permintaan normal. Jika permintaan valid, kode status HTTP 2xx dikembalikan dan templat pemeriksaan kesehatan dibuat.

    true
    Tag

    array<object>

    No

    Tag.

    object

    No

    Tag.

    Key

    string

    No

    Kunci tag. Panjang kunci tag dapat hingga 128 karakter. Kunci tidak boleh dimulai dengan aliyun atau acs: dan tidak boleh berisi http:// atau https://.

    env
    Value

    string

    No

    Nilai tag. Panjang nilai tag dapat hingga 128 karakter. Nilai tidak boleh dimulai dengan aliyun atau acs: dan tidak boleh berisi http:// atau https://.

    product
    ResourceGroupId

    string

    No

    ID grup resource.

    rg-atstuj3rtop****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Objek templat pemeriksaan kesehatan.

    HealthCheckTemplateId

    string

    ID templat pemeriksaan kesehatan.

    hct-pno8sisi******
    RequestId

    string

    ID permintaan.

    365F4154-92F6-4AE4-92F8-7FF34******

    Contoh

    Respons sukses

    JSONformat

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

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 QuotaExceeded.HealthCheckTemplatesNum The quota of %s is exceeded, usage %s/%s.
    403 Forbidden.HealthCheckTemplate Authentication has failed for HealthCheckTemplate.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.