全部产品
Search

搜索本产品

    Server Load Balancer：UpdateHealthCheckTemplateAttribute

    文档中心

    Server Load Balancer：UpdateHealthCheckTemplateAttribute

    更新时间：Dec 19, 2025

    Memodifikasi atribut, seperti nama dan protokol, dari sebuah health check template.

    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 client yang digunakan untuk memastikan idempotensi permintaan.

    Anda dapat menggunakan client untuk menghasilkan token tersebut, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Token hanya boleh berisi karakter ASCII.

    Catatan

    Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan ID permintaan sebagai client token. ID permintaan mungkin berbeda untuk setiap permintaan.

    5A2CFF0E-5718-45B5-9D4D-70B3FF3898
    HealthCheckTemplateName

    string

    No

    Nama health check template.

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

    HealthCheckTemplate1
    HealthCheckConnectPort

    integer

    No

    Port yang digunakan untuk health check. Nilai yang valid: 0 hingga 65535. Nilai default: 0. Nilai ini menunjukkan bahwa port server backend digunakan untuk health check.

    80
    HealthCheckHost

    string

    No

    Nama domain yang digunakan untuk health check. Nilai yang valid:

    • $SERVER_IP (default): Alamat IP pribadi server backend. Jika alamat IP ditentukan, atau parameter ini tidak ditentukan, instans ALB menggunakan alamat IP pribadi server backend sebagai nama domain untuk health check.

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

    Catatan

    Parameter ini hanya tersedia jika HealthCheckProtocol diatur ke HTTP atau HTTPS.

    $_ip
    HealthCheckCodes

    array

    No

    Kode status HTTP yang menunjukkan bahwa server backend dalam kondisi sehat.

    5

    string

    No

    Kode status HTTP yang menunjukkan bahwa server backend dalam kondisi sehat.

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

    • Jika HealthCheckProtocol diatur ke gRPC, nilai yang valid untuk HealthCheckCodes berkisar dari 0 hingga 99. Nilai default adalah 0. Rentang nilai didukung. Anda dapat memasukkan maksimal 20 rentang nilai. Pisahkan beberapa rentang nilai dengan koma (,).

    Catatan

    Parameter ini hanya tersedia jika Anda mengatur HealthCheckProtocol ke HTTP, HTTPS, atau gRPC.

    http_2xx,http_3xx
    HealthCheckInterval

    integer

    No

    Interval pelaksanaan health check. Satuan: detik. Nilai yang valid: 1 hingga 50. Nilai default: 2.

    5
    HealthCheckTimeout

    integer

    No

    Waktu timeout respons health check. Jika server backend tidak merespons dalam periode timeout yang ditentukan, server backend tersebut dinyatakan tidak sehat.

    Satuan: detik. Nilai yang valid: 1 hingga 300. Nilai default: 5.

    3
    HealthCheckPath

    string

    No

    URL yang digunakan untuk health check.

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

    URL harus dimulai dengan garis miring (/).

    Catatan

    Parameter ini hanya tersedia jika Anda mengatur HealthCheckProtocol ke HTTP, HTTPS, atau gRPC.

    /test/index.html
    HealthCheckMethod

    string

    No

    Metode HTTP yang digunakan untuk health check. Nilai yang valid:

    • HEAD (default): Secara default, health check HTTP dan HTTPS menggunakan metode HEAD.

    • GET: Jika panjang respons melebihi 8 KB, respons akan dipotong. Namun, hasil health check tidak terpengaruh.

    • POST: Health check gRPC menggunakan metode POST secara default.

    Catatan

    Parameter ini hanya tersedia jika Anda mengatur HealthCheckProtocol ke HTTP, HTTPS, atau gRPC.

    HEAD
    HealthCheckProtocol

    string

    No

    Protokol yang digunakan untuk health check. Nilai yang valid:

    • HTTP (default): Health check HTTP mensimulasikan perilaku browser dengan mengirim permintaan HEAD atau GET untuk memeriksa ketersediaan server backend.

    • HTTPS: Instans ALB mengirim permintaan HEAD atau GET, yang mensimulasikan permintaan browser, untuk memeriksa apakah server backend dalam kondisi sehat. HTTPS mendukung enkripsi dan menyediakan keamanan lebih tinggi dibandingkan HTTP.

    • TCP: Health check TCP mengirim paket TCP SYN ke server backend untuk memeriksa apakah port server backend dapat dijangkau.

    • gRPC: Health check gRPC mengirim permintaan POST atau GET ke server backend untuk memeriksa apakah server backend dalam kondisi sehat.

    HTTP
    HealthCheckHttpVersion

    string

    No

    Versi HTTP yang digunakan untuk health check.

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

    Nilai default: HTTP1.1.

    Catatan

    Parameter ini hanya tersedia jika Anda mengatur HealthCheckProtocol ke HTTP atau HTTPS.

    HTTP1.0
    HealthyThreshold

    integer

    No

    Jumlah kali berturut-turut server backend yang tidak sehat harus lulus health check sebelum dinyatakan sehat. Dalam kasus ini, status kesehatan berubah dari fail menjadi success.

    Nilai yang valid: 2 hingga 10.

    Nilai default: 3.

    4
    UnhealthyThreshold

    integer

    No

    Jumlah kali berturut-turut server backend yang sehat harus gagal dalam health check sebelum dinyatakan tidak sehat. Dalam kasus ini, status kesehatan berubah dari success menjadi fail.

    Nilai yang valid: 2 hingga 10.

    Nilai default: 3.

    4
    DryRun

    boolean

    No

    Menentukan apakah hanya melakukan dry run tanpa menjalankan permintaan sebenarnya. Nilai yang valid:

    • true: hanya melakukan dry run. Sistem memeriksa permintaan terhadap potensi masalah, termasuk nilai parameter yang hilang, sintaks permintaan yang salah, dan batas layanan. Jika permintaan gagal dalam dry run, kode kesalahan akan dikembalikan. Jika permintaan lolos dry run, kode kesalahan DryRunOperation akan dikembalikan.

    • false (default): melakukan dry run dan menjalankan permintaan sebenarnya. Jika permintaan lolos dry run, kode status HTTP 2xx akan dikembalikan dan operasi dilakukan.

    true
    HealthCheckTemplateId

    string

    Yes

    ID templat.

    hct-bp1qjwo61pqz3ahltv0mw

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    RequestId

    string

    ID permintaan.

    365F4154-92F6-4AE4-92F8-7FF34B540710

    Contoh

    Respons sukses

    JSONformat

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

    Kode kesalahan

    HTTP status code

    Error code

    Error message

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

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.