GetHealthStatus - Global Accelerator

Mengambil status kesehatan titik akhir dan kelompok titik akhir dari suatu 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

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah tempat instans Global Accelerator (GA) ditempatkan. Tetapkan nilainya ke cn-hangzhou.	cn-hangzhou
ClientToken	string	No	Token client yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan client 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 request ID sebagai client token. Request ID mungkin berbeda untuk setiap permintaan.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Menentukan apakah hanya melakukan pemeriksaan awal terhadap permintaan. Nilai yang valid: true: hanya melakukan pemeriksaan awal. Status kesehatan Pendengar tidak ditanyakan. Sistem memeriksa parameter yang diperlukan, sintaksis permintaan, dan batasan. Jika permintaan gagal dalam pemeriksaan awal, pesan kesalahan akan dikembalikan. Jika permintaan lolos pemeriksaan awal, kode kesalahan `DryRunOperation` akan 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 tanyakan.	ga-bp1odcab8tmno0hdq****
ListenerId	string	Yes	ID Pendengar.	lsr-bp1bpn0kn908w4nbw****

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF
ListenerId	string	ID Pendengar.	lsr-bp1bpn0kn908w4nbw****
HealthStatus	string	Status kesehatan titik akhir dan kelompok titik akhir. Nilai yang valid: normal abnormal partiallyAbnormal	normal
EndpointGroups	array<object>	Informasi tentang kelompok titik akhir.
	array<object>	Informasi tentang kelompok titik akhir.
EndpointGroupId	string	ID kelompok titik akhir.	epg-bp14sz7ftcwwjgrdm****
EndpointGroupType	string	Tipe kelompok titik akhir. Nilai yang valid: default: kelompok titik akhir default. virtual: kelompok titik akhir virtual.	default
HealthStatus	string	Status kesehatan kelompok titik akhir. Nilai yang valid: init: Kelompok titik akhir sedang diinisialisasi. normal: Kelompok titik akhir normal. abnormal: Kelompok titik akhir abnormal. partiallyAbnormal: Kelompok titik akhir sebagian abnormal.	normal
ForwardingRuleIds	array	ID aturan pengalihan.
	string	ID aturan pengalihan.	frule-bp134k63nmtwmnwee****
Endpoints	array<object>	Informasi tentang titik akhir.
	object	Informasi tentang titik akhir.
EndpointId	string	ID titik akhir.	ep-hp33b2e43fays7s8****
Address	string	Alamat IP titik akhir.	47.0.XX.XX
HealthStatus	string	Status kesehatan titik akhir. Nilai yang valid: init: Titik akhir sedang diinisialisasi. normal: Titik akhir normal. abnormal: Titik akhir abnormal.	normal
HealthDetail	string	Detail pemeriksaan kesehatan titik akhir. Catatan Parameter ini tidak tersedia.	null
Port	integer	Port yang digunakan untuk menghubungkan ke titik akhir.	80
Type	string	Tipe titik akhir. Nilai yang valid: Domain: nama domain kustom. Ip: alamat IP kustom. PublicIp: Alamat IP publik yang disediakan oleh Alibaba Cloud. ECS: instans Elastic Compute Service (ECS). SLB: instans Classic Load Balancer (CLB). ALB: instans Application Load Balancer (ALB). OSS: bucket Object Storage Service (OSS). ENI: antarmuka jaringan elastis (ENI). NLB: instans Network Load Balancer (NLB).	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.