All Products
Search

This Product

    Server Load Balancer:UpdateHealthCheckTemplateAttribute

    Document Center

    Server Load Balancer:UpdateHealthCheckTemplateAttribute

    Last Updated:Jun 10, 2026

    Memperbarui atribut templat pemeriksaan kesehatan, seperti namanya dan protokol pemeriksaan kesehatan.

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

    update

    *HealthCheckTemplate

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ClientToken

    string

    No

    Token klien yang digunakan untuk memastikan idempotensi permintaan.

    Anda harus menghasilkan nilai unik pada klien Anda untuk setiap permintaan. Token klien hanya boleh berisi karakter ASCII.

    Catatan

    Jika Anda tidak menentukan parameter ini, sistem akan menggunakan RequestId permintaan sebagai ClientToken. RequestId setiap permintaan bersifat unik.

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

    string

    No

    Nama templat pemeriksaan kesehatan.

    Nama harus terdiri dari 2 hingga 128 karakter, diawali dengan huruf, karakter Cina, atau angka, dan dapat berisi huruf, karakter Cina, angka, periode (.), garis bawah (_), tanda hubung (-), dan spasi.

    HealthCheckTemplate1
    HealthCheckConnectPort

    integer

    No

    Port yang digunakan untuk pemeriksaan kesehatan. Nilai 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 valid:

    • $SERVER_IP (default): Alamat IP privat server backend. Jika Anda menentukan nilai ini atau mengosongkan parameter ini, layanan load balancing akan menggunakan alamat IP privat server backend untuk pemeriksaan kesehatan.

    • domain: Nama domain yang terdiri dari 1 hingga 80 karakter dan dapat berisi huruf, angka, periode (.), dan tanda hubung (-).

    Catatan

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

    $SERVER_IP
    HealthCheckCodes

    array

    No

    Daftar kode status yang menunjukkan keadaan sehat.

    5

    string

    No

    The HTTP status codes that indicate a healthy backend server.

    • If HealthCheckProtocol is set to HTTP or HTTPS, specify one or more of the following values: http_2xx (default), http_3xx, http_4xx, and http_5xx. Separate multiple values with commas.

    • If HealthCheckProtocol is set to gRPC, the valid status codes are in the range of 0 to 99. The default value is 0. You can specify up to 20 ranges, separated by commas.

    Catatan

    This parameter takes effect only when the HealthCheckProtocol parameter is set to HTTP, HTTPS, or gRPC.

    http_2xx
    HealthCheckInterval

    integer

    No

    Interval antar Pemeriksaan kesehatan, dalam detik. Nilai valid: 1 hingga 50. Nilai default: 2.

    5
    HealthCheckTimeout

    integer

    No

    Periode batas waktu, dalam detik, untuk tanggapan Pemeriksaan kesehatan. Jika server backend tidak merespons dalam periode ini, pemeriksaan kesehatan gagal.

    Nilai valid: 1 hingga 300. Nilai default: 5.

    3
    HealthCheckPath

    string

    No

    URL yang digunakan untuk pemeriksaan kesehatan.

    URL harus terdiri dari 1 hingga 80 karakter. URL dapat berisi huruf, angka, tanda hubung (-), garis miring (/), periode (.), tanda persen (%), tanda tanya (?), tanda pagar (#), tanda ampersand (&), dan karakter tambahan berikut: _;~!()*[]@$^:',+.

    URL harus diawali dengan garis miring (/).

    Catatan

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

    /test/index.html
    HealthCheckMethod

    string

    No

    Metode yang digunakan untuk pemeriksaan kesehatan. Nilai valid:

    • HEAD (default): Metode default untuk pemeriksaan kesehatan pada listener HTTP dan HTTPS.

    • GET: Jika badan respons lebih besar dari 8 KB, badan respons akan dipotong. Hal ini tidak memengaruhi hasil pemeriksaan kesehatan.

    • POST: Metode default untuk pemeriksaan kesehatan pada listener gRPC.

    Catatan

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

    HEAD
    HealthCheckProtocol

    string

    No

    Protokol yang digunakan untuk pemeriksaan kesehatan. Nilai valid:

    • HTTP (default): Memeriksa kesehatan server backend dengan mengirim permintaan HTTP HEAD atau GET.

    • HTTPS: Memeriksa kesehatan server backend dengan mengirim permintaan HTTPS HEAD atau GET. HTTPS lebih aman daripada HTTP karena mengenkripsi data.

    • TCP: Memeriksa apakah port pada server backend dapat dijangkau dengan mengirim Paket TCP SYN.

    • gRPC: Memeriksa kesehatan server backend dengan mengirim permintaan POST atau GET.

    HTTP
    HealthCheckHttpVersion

    string

    No

    Versi HTTP yang digunakan untuk pemeriksaan kesehatan.

    Nilai valid: HTTP1.0 dan HTTP1.1.

    Nilai default: HTTP1.1.

    Catatan

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

    HTTP1.0
    HealthyThreshold

    integer

    No

    Jumlah pemeriksaan kesehatan berturut-turut yang berhasil yang diperlukan sebelum server backend dinyatakan sehat. Dalam hal ini, status kesehatan berubah dari fail menjadi success.

    Nilai valid: 2 hingga 10.

    Nilai default: 3.

    4
    UnhealthyThreshold

    integer

    No

    Jumlah pemeriksaan kesehatan berturut-turut yang gagal yang diperlukan sebelum server backend dinyatakan tidak sehat. Dalam hal ini, status kesehatan berubah dari success menjadi fail.

    Nilai valid: 2 hingga 10.

    Nilai default: 3.

    4
    DryRun

    boolean

    No

    Apakah akan menjalankan dry run. Nilai valid:

    • true: Menjalankan dry run. Sistem memeriksa parameter yang diperlukan, sintaks permintaan, dan batas. Jika permintaan gagal pemeriksaan, Paket kesalahan akan dikembalikan. Jika permintaan lulus pemeriksaan, kode kesalahan DryRunOperation akan dikembalikan.

    • false (default): Mengirim permintaan normal. Jika permintaan lulus pemeriksaan, kode status HTTP 2xx akan dikembalikan dan operasi akan dijalankan.

    true
    HealthCheckTemplateId

    string

    Yes

    ID templat pemeriksaan kesehatan.

    hct-bp1qjwo61******

    Elemen respons

    Element

    Type

    Description

    Example

    object

    The response to the update request.

    RequestId

    string

    The request ID.

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

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF3******"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 IncorrectStatus.HealthCheckTemplate The status of %s [%s] is incorrect.
    403 Forbidden.HealthCheckTemplate Authentication is failed for %s.
    404 ResourceNotFound.HealthCheckTemplate The specified resource %s is not found.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.