全部产品
Search

搜索本产品

    Server Load Balancer：ListHealthCheckTemplates

    文档中心

    Server Load Balancer：ListHealthCheckTemplates

    更新时间：Dec 19, 2025

    Mengambil daftar templat Pemeriksaan kesehatan di suatu Wilayah.

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

    list

    *HealthCheckTemplate

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    NextToken

    string

    No

    Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Nilai yang valid:

    • Anda tidak perlu menentukan parameter ini untuk permintaan pertama.

    • Anda harus menentukan token yang diperoleh dari kueri sebelumnya sebagai nilai NextToken.

    FFmyTO70tTpLG6I3FmYAXGKPd****
    MaxResults

    integer

    No

    Jumlah entri yang dikembalikan dalam setiap panggilan. Nilai yang valid: 1 hingga 100. Nilai default: 20

    50
    HealthCheckTemplateIds

    array

    No

    ID templat Pemeriksaan kesehatan.

    string

    No

    ID templat Pemeriksaan kesehatan. Anda dapat menentukan hingga 20 ID dalam setiap panggilan. Hasilnya difilter berdasarkan ID yang ditentukan.

    hct-bp1qjwo61pqz3ahltv****
    HealthCheckTemplateNames

    array

    No

    Templat Pemeriksaan kesehatan.

    string

    No

    Nama templat Pemeriksaan kesehatan. Anda dapat menentukan hingga 10 nama dalam setiap panggilan. Hasilnya difilter berdasarkan nama yang ditentukan.

    test
    Tag

    array<object>

    No

    Tag.

    object

    No

    Tag.

    Key

    string

    No

    Kunci tag. Panjang kunci tag dapat mencapai 128 karakter dan tidak boleh diawali dengan acs: atau aliyun. Kunci tag tidak boleh mengandung http:// atau https://.

    env
    Value

    string

    No

    Nilai tag. Panjang nilai tag dapat mencapai 128 karakter dan tidak boleh diawali dengan acs: atau aliyun. Nilai tag tidak boleh mengandung http:// atau https://.

    product
    ResourceGroupId

    string

    No

    ID kelompok sumber daya. Anda dapat memfilter hasil kueri berdasarkan ID yang ditentukan.

    rg-atstuj3rtop****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Informasi tentang templat Pemeriksaan kesehatan.

    HealthCheckTemplates

    array<object>

    Templat Pemeriksaan kesehatan.

    array<object>

    Informasi tentang templat Pemeriksaan kesehatan.

    HealthCheckConnectPort

    integer

    Port yang digunakan untuk Pemeriksaan kesehatan.

    Nilai yang valid: ** 0 hingga 65535**.

    Nilai default adalah 0, yang menunjukkan bahwa port server backend digunakan untuk Pemeriksaan kesehatan.

    80
    HealthCheckHost

    string

    Nama domain yang digunakan untuk Pemeriksaan kesehatan. 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 setiap server backend sebagai nama domain untuk Pemeriksaan kesehatan.

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

    Catatan

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

    $_ip
    HealthCheckCodes

    array

    Kode status HTTP yang menunjukkan server backend dalam kondisi sehat.

    string

    Kode status HTTP yang menunjukkan 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 berlaku jika Anda menetapkan HealthCheckProtocol ke HTTP, HTTPS, atau gRPC.

    http_2xx,http_3xx
    HealthCheckHttpVersion

    string

    Versi HTTP untuk Pemeriksaan kesehatan.

    Nilai yang valid: HTTP 1.0 dan HTTP 1.1.

    Nilai default: HTTP 1.1.

    Catatan

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

    HTTP 1.0
    HealthCheckInterval

    integer

    Interval pelaksanaan Pemeriksaan kesehatan. Satuan: detik. Nilai yang valid: 1 hingga 50. Nilai default: 2.

    5
    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 tersebut akan dipotong. Namun, hasil Pemeriksaan kesehatan tidak terpengaruh.

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

    Catatan

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

    HEAD
    HealthCheckPath

    string

    Jalur URL yang ingin Anda gunakan untuk Pemeriksaan kesehatan.

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

    /test/index.html
    HealthCheckProtocol

    string

    Protokol yang digunakan untuk Pemeriksaan kesehatan. Nilai yang valid:

    • HTTP (default): Instans ALB mengirim permintaan HEAD atau GET, yang mensimulasikan permintaan browser, untuk memeriksa apakah server backend dalam kondisi sehat.

    • HTTPS: Pemeriksaan kesehatan HTTPS mensimulasikan perilaku browser dengan mengirim permintaan HEAD atau GET untuk memeriksa ketersediaan server backend. HTTPS menyediakan keamanan lebih tinggi karena mendukung enkripsi data.

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

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

    HTTP
    HealthCheckTemplateId

    string

    ID templat Pemeriksaan kesehatan.

    hct-bp1qjwo61pqz3ahltv****
    HealthCheckTemplateName

    string

    Nama templat Pemeriksaan kesehatan.

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

    HealthCheckTemplate1
    HealthCheckTimeout

    integer

    Periode timeout respons Pemeriksaan kesehatan. Jika instans Elastic Compute Service (ECS) backend tidak merespons dalam periode timeout yang ditentukan, instans ECS tersebut gagal dalam Pemeriksaan kesehatan.

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

    Nilai default: 5.

    3
    HealthyThreshold

    integer

    Jumlah kali server backend yang tidak sehat harus lulus Pemeriksaan kesehatan secara berturut-turut 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

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

    Nilai yang valid: 2 hingga 10.

    Nilai default: 3.

    4
    Tags

    array<object>

    Tag.

    object

    Tag.

    Key

    string

    Kunci tag. Panjang kunci tag dapat mencapai 128 karakter, dan tidak boleh mengandung http:// atau https://. Kunci tag tidak boleh diawali dengan acs: atau aliyun.

    env
    Value

    string

    Nilai tag. Panjang nilai tag dapat mencapai 128 karakter, dan tidak boleh mengandung http:// atau https://. Nilai tag tidak boleh diawali dengan acs: atau aliyun.

    product
    ResourceGroupId

    string

    ID kelompok sumber daya.

    rg-atstuj3rtop****
    MaxResults

    integer

    Jumlah entri yang dikembalikan per halaman. Nilai yang valid: 1 hingga 100. Nilai default: 20.

    50
    NextToken

    string

    Nilai NextToken yang dikembalikan merupakan token paginasi, yang dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Nilai yang valid:

    • Jika NextToken kosong, berarti tidak ada halaman berikutnya.

    • Jika nilai NextToken dikembalikan dalam kueri sebelumnya, tentukan nilai tersebut untuk mendapatkan set hasil berikutnya.

    FFmyTO70tTpLG6I3FmYAXGKPd****
    RequestId

    string

    ID permintaan.

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

    integer

    Total jumlah entri yang dikembalikan.

    1000

    Contoh

    Respons sukses

    JSONformat

    {
  "HealthCheckTemplates": [
    {
      "HealthCheckConnectPort": 80,
      "HealthCheckHost": "$_ip",
      "HealthCheckCodes": [
        "http_2xx,http_3xx"
      ],
      "HealthCheckHttpVersion": "HTTP 1.0",
      "HealthCheckInterval": 5,
      "HealthCheckMethod": "HEAD",
      "HealthCheckPath": "/test/index.html",
      "HealthCheckProtocol": "HTTP",
      "HealthCheckTemplateId": "hct-bp1qjwo61pqz3ahltv****",
      "HealthCheckTemplateName": "HealthCheckTemplate1",
      "HealthCheckTimeout": 3,
      "HealthyThreshold": 4,
      "UnhealthyThreshold": 4,
      "Tags": [
        {
          "Key": "env",
          "Value": "product"
        }
      ],
      "ResourceGroupId": "rg-atstuj3rtop****"
    }
  ],
  "MaxResults": 50,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "TotalCount": 1000
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    403 Forbidden.HealthCheckTemplate Authentication has failed for HealthCheckTemplate.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.