All Products
Search

This Product

    Global Accelerator:GetHealthStatus

    Document Center

    Global Accelerator:GetHealthStatus

    Last Updated:Jun 10, 2026

    Mengkueri status kesehatan titik akhir dan kelompok titik akhir dari sebuah Pendengar.

    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

    ga:GetHealthStatus

    get

    *Listener

    acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID Wilayah tempat instans Akselerator Global (GA) di-deploy. Atur nilainya ke cn-hangzhou.

    cn-hangzhou
    ClientToken

    string

    No

    token Klien yang digunakan untuk memastikan idempotensi permintaan.

    Anda dapat menggunakan Klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. token hanya boleh berisi karakter ASCII dan tidak boleh melebihi 64 karakter.

    Catatan

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

    123e4567-e89b-12d3-a456-426655440000
    DryRun

    boolean

    No

    Apakah akan melakukan Pemeriksaan Awal permintaan saja. Nilai valid:

    • true: Hanya melakukan Pemeriksaan Awal permintaan. Status kesehatan Pendengar tidak dikueri. Sistem melakukan Pemeriksaan Awal pada parameter yang diperlukan, sintaksis permintaan, dan batasan. Jika permintaan gagal Pemeriksaan Awal, Paket kesalahan dikembalikan. Jika permintaan lolos Pemeriksaan Awal, kode kesalahan DryRunOperation dikembalikan.

    • false (default): Mengirim permintaan normal. Jika permintaan lolos Pemeriksaan Awal, kode status HTTP 2xx dikembalikan dan status kesehatan Pendengar diperoleh.

    true
    AcceleratorId

    string

    Yes

    ID instans GA yang ingin Anda kueri.

    ga-bp1odcab8tmno0hdq****
    ListenerId

    string

    Yes

    ID Pendengar.

    lsr-bp1bpn0kn908w4nbw****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The ID of the request.

    64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
    ListenerId

    string

    The ID of the listener.

    lsr-bp1bpn0kn908w4nbw****
    HealthStatus

    string

    The health status of endpoints and endpoint groups. Valid values:

    • normal

    • abnormal

    • partiallyAbnormal

    normal
    EndpointGroups

    array<object>

    The information about the endpoint groups.

    array<object>

    The information about the endpoint group.

    EndpointGroupId

    string

    The ID of the endpoint group.

    epg-bp14sz7ftcwwjgrdm****
    EndpointGroupType

    string

    The type of the endpoint group. Valid values:

    • default: the default endpoint group.

    • virtual: a virtual endpoint group.

    default
    HealthStatus

    string

    The health status of the endpoint group. Valid values:

    • init: The endpoint group is being initialized.

    • normal: The endpoint group is normal.

    • abnormal: The endpoint group is abnormal.

    • partiallyAbnormal: The endpoint group is partially abnormal.

    normal
    ForwardingRuleIds

    array

    The IDs of the forwarding rules.

    string

    The ID of the forwarding rule.

    frule-bp134k63nmtwmnwee****
    Endpoints

    array<object>

    The information about the endpoints.

    object

    The information about the endpoints.

    EndpointId

    string

    The ID of the endpoint.

    ep-hp33b2e43fays7s8****
    Address

    string

    The IP address of the endpoint.

    47.0.XX.XX
    HealthStatus

    string

    The health status of the endpoint. Valid values:

    • init: The endpoint is being initialized.

    • normal: The endpoint is normal.

    • abnormal: The endpoint is abnormal.

    normal
    HealthDetail

    string

    The health check details of the endpoint.

    Catatan

    This parameter is unavailable.

    null
    Port

    integer

    The port that is used to connect to the endpoint.

    80
    Type

    string

    The type of the endpoint. Valid values:

    • Domain: a custom domain name.

    • Ip: a custom IP address.

    • PublicIp: a public IP address provided by Alibaba Cloud.

    • ECS: an Elastic Compute Service (ECS) instance.

    • SLB: a Classic Load Balancer (CLB) instance.

    • ALB: an Application Load Balancer (ALB) instance.

    • OSS: an Object Storage Service (OSS) bucket.

    • ENI: an elastic network interface (ENI).

    • NLB: a Network Load Balancer (NLB) instance.

    Ip

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "HealthStatus": "normal",
  "EndpointGroups": [
    {
      "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
      "EndpointGroupType": "default",
      "HealthStatus": "normal",
      "ForwardingRuleIds": [
        "frule-bp134k63nmtwmnwee****"
      ],
      "Endpoints": [
        {
          "EndpointId": "ep-hp33b2e43fays7s8****",
          "Address": "47.0.XX.XX",
          "HealthStatus": "normal",
          "HealthDetail": "无",
          "Port": 80,
          "Type": "Ip"
        }
      ]
    }
  ]
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.