All Products
Search

This Product

    Server Load Balancer:GetHealthCheckTemplateAttribute

    Document Center

    Server Load Balancer:GetHealthCheckTemplateAttribute

    Last Updated:Jun 10, 2026

    Mengambil detail tentang templat 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:GetHealthCheckTemplateAttribute

    get

    *HealthCheckTemplate

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    HealthCheckTemplateId

    string

    Yes

    ID templat pemeriksaan kesehatan.

    hct-x4jazoyi6tvsq9****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Skema Respons

    HealthCheckConnectPort

    integer

    Port yang digunakan untuk pemeriksaan kesehatan.

    Nilai yang valid: 0 hingga 65535.

    80
    HealthCheckHost

    string

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

    • $SERVER_IP: alamat IP privat dari server backend. Jika alamat IP ditentukan, atau parameter ini tidak ditentukan, instance ALB menggunakan alamat IP privat dari server backend sebagai nama domain untuk pemeriksaan kesehatan.

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

    Catatan

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

    $SERVER_IP
    HealthCheckCodes

    array

    Kode status HTTP yang menunjukkan server backend dalam keadaan sehat.

    string

    Kode status HTTP yang menunjukkan server backend dalam keadaan 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 adalah dari 0 hingga 99. Nilai default adalah 0. Rentang nilai didukung. Anda dapat memasukkan paling banyak 20 rentang nilai. Pisahkan beberapa rentang nilai dengan koma (,).

    Catatan

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

    http_2xx,http_3xx
    HealthCheckHttpVersion

    string

    Versi HTTP untuk pemeriksaan kesehatan.

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

    Catatan

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

    HTTP1.0
    HealthCheckTemplateId

    string

    ID templat pemeriksaan kesehatan.

    hct-x4jazoyi6tvsq9****
    HealthCheckInterval

    integer

    Interval di mana pemeriksaan kesehatan dilakukan. Satuan: detik. Nilai yang valid: 1 hingga 50.

    3
    HealthCheckMethod

    string

    Metode HTTP yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid:

    • HEAD (default): Secara default, pemeriksaan kesehatan HTTP dan HTTPS menggunakan metode HEAD.

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

    • POST: Pemeriksaan kesehatan gRPC menggunakan metode POST secara default.

    Catatan

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

    GET
    HealthCheckPath

    string

    URL yang digunakan untuk pemeriksaan kesehatan.

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

    Catatan

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

    /test/index.html
    HealthCheckProtocol

    string

    Protokol yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid:

    • HTTP (default): Pemeriksaan kesehatan HTTP mensimulasikan perilaku browser dengan mengirim permintaan HEAD atau GET untuk menyelidiki ketersediaan server backend.

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

    • TCP: Pemeriksaan kesehatan TCP mengirim paket TCP SYN ke server backend untuk menyelidiki ketersediaan server backend.

    • gRPC: Pemeriksaan kesehatan gRPC mengirim permintaan POST atau GET ke server backend untuk menyelidiki ketersediaan server backend.

    HTTP
    HealthCheckTemplateName

    string

    Nama templat pemeriksaan kesehatan.

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

    HealthCheckTemplate1
    HealthCheckTimeout

    integer

    Periode waktu habis untuk respons pemeriksaan kesehatan. Jika server backend tidak merespons dalam periode waktu habis yang ditentukan, server backend dinyatakan tidak sehat. Satuan: detik.

    Nilai yang valid: 1 hingga 300.

    200
    HealthyThreshold

    integer

    Jumlah kali server backend yang tidak sehat harus berhasil melewati pemeriksaan kesehatan secara berturut-turut sebelum dinyatakan sehat. Dalam hal ini, status kesehatan diubah dari fail menjadi success.

    Nilai yang valid: 2 hingga 10.

    5
    RequestId

    string

    ID permintaan.

    DB1AFC33-DAE8-528E-AA4D-4A6AABE71945
    UnhealthyThreshold

    integer

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

    Nilai yang valid: 2 hingga 10.

    5
    Tags

    array<object>

    Tag.

    object

    Tag.

    Key

    string

    Kunci tag. Kunci tag dapat berisi hingga 128 karakter, dan tidak boleh berisi http:// atau https://. Kunci tag tidak boleh diawali dengan acs: atau aliyun.

    env
    Value

    string

    Nilai tag. Nilai tag dapat berisi hingga 128 karakter, dan tidak boleh diawali dengan acs:. Nilai tag tidak boleh berisi http:// atau https://.

    product
    ResourceGroupId

    string

    ID grup sumber daya.

    rg-atstuj3rtop****

    Contoh

    Respons sukses

    JSONformat

    {
  "HealthCheckConnectPort": 80,
  "HealthCheckHost": "$SERVER_IP",
  "HealthCheckCodes": [
    "http_2xx,http_3xx"
  ],
  "HealthCheckHttpVersion": "HTTP1.0",
  "HealthCheckTemplateId": "hct-x4jazoyi6tvsq9****",
  "HealthCheckInterval": 3,
  "HealthCheckMethod": "GET",
  "HealthCheckPath": "/test/index.html",
  "HealthCheckProtocol": "HTTP",
  "HealthCheckTemplateName": "HealthCheckTemplate1",
  "HealthCheckTimeout": 200,
  "HealthyThreshold": 5,
  "RequestId": "DB1AFC33-DAE8-528E-AA4D-4A6AABE71945",
  "UnhealthyThreshold": 5,
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ],
  "ResourceGroupId": "rg-atstuj3rtop****"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    403 Forbidden.HealthCheckTemplate Authentication has failed for HealthCheckTemplate.
    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.