GetListenerHealthStatus - Server Load Balancer

Mengambil status pemeriksaan kesehatan suatu listener dan aturan pengalihannya.

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

get

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	ID listener.	lsr-bp1bpn0kn908w4nbw****
IncludeRule	boolean	No	Menentukan apakah akan mengembalikan hasil pemeriksaan kesehatan aturan pengalihan. Nilai yang valid: true false (default)	true
NextToken	string	No	Token yang menentukan titik awal kueri. Nilai yang valid: Jika ini adalah kueri pertama Anda atau tidak ada kueri lanjutan, abaikan parameter ini. Jika akan mengirim kueri lanjutan, tetapkan nilainya ke nilai NextToken yang dikembalikan dari panggilan sebelumnya.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai yang valid: 1 hingga 30. Nilai default: 20.	20

Elemen respons

Element	Type	Description	Example
	object	Status pemeriksaan kesehatan listener dan aturan pengalihannya.
ListenerHealthStatus	array<object>	Status pemeriksaan kesehatan kelompok server yang terkait dengan listener.
	array<object>	Status pemeriksaan kesehatan kelompok server yang terkait dengan listener.
ListenerId	string	ID listener.	lsr-bp1bpn0kn908w4nbw****
ListenerPort	integer	Port listener.	80
ListenerProtocol	string	Protokol listener.	http
ServerGroupInfos	array<object>	Informasi mengenai kelompok server.
	array<object>	Informasi mengenai kelompok server.
HealthCheckEnabled	string	Menunjukkan apakah pemeriksaan kesehatan diaktifkan. Jika dikembalikan nilai on, berarti pemeriksaan kesehatan diaktifkan.	on
NonNormalServers	array<object>	Daftar server backend yang tidak sehat.
	array<object>	Daftar server backend yang tidak sehat.
Port	integer	Port backend.	90
Reason	object	Penyebab kondisi tidak sehat pada server backend.
ActualResponse	string	Kode status HTTP yang dikembalikan dari server, misalnya 302. Catatan Nilai hanya dikembalikan jika `ReasonCode` diatur ke RESPONSE_MISMATCH.	302
ExpectedResponse	string	Kode status HTTP yang dikembalikan setelah server backend lulus pemeriksaan kesehatan. Nilai yang valid: HTTP_2xx, HTTP_3xx, HTTP_4xx, dan HTTP_5xx. Beberapa kode status dipisahkan dengan koma (,). Catatan Nilai hanya dikembalikan jika ReasonCode diatur ke RESPONSE_MISMATCH.	HTTP_2xx
ReasonCode	string	Alasan mengapa nilai Status adalah Unhealthy. Hanya listener HTTP dan HTTPS yang mendukung parameter ini. CONNECT_TIMEOUT: ALB gagal terhubung ke server backend dalam periode waktu yang ditentukan. CONNECT_FAILED: ALB gagal terhubung ke server backend. RECV_RESPONSE_FAILED: ALB gagal menerima respons dari server backend. RECV_RESPONSE_TIMEOUT: ALB gagal menerima respons dari server backend dalam periode waktu yang ditentukan. SEND_REQUEST_FAILED: ALB gagal mengirim permintaan ke server backend. SEND_REQUEST_TIMEOUT: ALB gagal mengirim permintaan ke server backend dalam periode waktu yang ditentukan. RESPONSE_FORMAT_ERROR: Format respons dari server backend tidak valid. RESPONSE_MISMATCH: Kode status HTTP yang dikembalikan dari server backend tidak sesuai dengan yang diharapkan.	RESPONSE_MISMATCH
ServerId	string	ID server backend.	rg-bp1bfa08ex*****
ServerIp	string	Alamat IP server backend.	192.168.8.10
Status	string	Status pemeriksaan kesehatan. Nilai yang valid: Initial: menunjukkan bahwa pemeriksaan kesehatan telah dikonfigurasi untuk instans NLB, tetapi tidak ditemukan data. Unhealthy: menunjukkan bahwa server backend gagal berturut-turut dalam pemeriksaan kesehatan. Unused: menunjukkan bahwa bobot server backend adalah 0. Unavailable: menunjukkan bahwa pemeriksaan kesehatan dinonaktifkan.	Initial
ServerGroupId	string	ID kelompok server yang terkait dengan listener.	vsp-bp1qjwo61pqz3ahltv****
ActionType	string	Aksi yang ditentukan untuk kelompok server. Nilai yang valid: ForwardGroup: mendistribusikan permintaan ke kelompok server. TrafficMirror: mencerminkan permintaan ke kelompok server.	TrafficMirror
RequestId	string	ID permintaan.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
RuleHealthStatus	array<object>	Status pemeriksaan kesehatan aturan pengalihan.
	array<object>	Status pemeriksaan kesehatan aturan pengalihan.
RuleId	string	ID aturan pengalihan.	rule-hp34s2h0xx1ht4nwo****
ServerGroupInfos	array<object>	Kelompok server.
	array<object>	Konfigurasi kelompok server.
HealthCheckEnabled	string	Menunjukkan apakah pemeriksaan kesehatan diaktifkan. Jika dikembalikan nilai on, berarti pemeriksaan kesehatan diaktifkan.	on
NonNormalServers	array<object>	Daftar server backend yang tidak sehat.
	array<object>	Daftar server backend yang tidak sehat.
Port	integer	Port backend.	90
Reason	object	Penyebab kondisi tidak sehat pada server backend.
ActualResponse	string	Kode status HTTP yang dikembalikan dari server, misalnya 302. Catatan Nilai hanya dikembalikan jika ReasonCode diatur ke RESPONSE_MISMATCH.	302
ExpectedResponse	string	Kode status HTTP yang dikembalikan setelah server backend lulus pemeriksaan kesehatan. Nilai yang valid: HTTP_2xx, HTTP_3xx, HTTP_4xx, dan HTTP_5xx. Beberapa kode status dipisahkan dengan koma (,). Catatan Nilai hanya dikembalikan jika ReasonCode diatur ke RESPONSE_MISMATCH.	HTTP_2xx
ReasonCode	string	Alasan mengapa nilai Status adalah Unhealthy. Hanya aturan pengalihan untuk listener HTTP dan HTTPS yang mendukung parameter ini. CONNECT_TIMEOUT: ALB gagal terhubung ke server backend dalam periode waktu yang ditentukan. CONNECT_FAILED: ALB gagal terhubung ke server backend. RECV_RESPONSE_FAILED: ALB gagal menerima respons dari server backend. RECV_RESPONSE_TIMEOUT: ALB gagal menerima respons dari server backend dalam periode waktu yang ditentukan. SEND_REQUEST_FAILED: ALB gagal mengirim permintaan ke server backend. SEND_REQUEST_TIMEOUT: ALB gagal mengirim permintaan ke server backend dalam periode waktu yang ditentukan. RESPONSE_FORMAT_ERROR: Format respons dari server backend tidak valid. RESPONSE_MISMATCH: Kode status HTTP yang dikembalikan dari server backend tidak sesuai dengan yang diharapkan.	RESPONSE_MISMATCH
ServerId	string	ID server backend.	rg-bp1bfa08ex****
ServerIp	string	Alamat IP kelompok server.	192.168.2.11
Status	string	Status pemeriksaan kesehatan. Nilai yang valid: Initial: menunjukkan bahwa pemeriksaan kesehatan telah dikonfigurasi untuk instans NLB, tetapi tidak ditemukan data. Unhealthy: menunjukkan bahwa server backend gagal berturut-turut dalam pemeriksaan kesehatan. Unused: menunjukkan bahwa bobot server backend adalah 0. Unavailable: menunjukkan bahwa pemeriksaan kesehatan dinonaktifkan.	Initial
ServerGroupId	string	ID kelompok server yang terkait dengan listener.	vsp-bp1qjwo61pqz3ahlt****
ActionType	string	Aksi yang ditentukan untuk kelompok server.	TrafficMirror
NextToken	string	Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil berikutnya. Nilai yang valid: Jika NextToken kosong, berarti tidak ada halaman berikutnya. Jika NextToken dikembalikan dalam kueri sebelumnya, tentukan nilainya untuk mendapatkan set hasil berikutnya.	FFmyTO70tTpLG6I3FmYAXGKPd****

Contoh

Respons sukses

JSONformat

{
  "ListenerHealthStatus": [
    {
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "ListenerPort": 80,
      "ListenerProtocol": "http",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": "on",
          "NonNormalServers": [
            {
              "Port": 90,
              "Reason": {
                "ActualResponse": "302",
                "ExpectedResponse": "HTTP_2xx",
                "ReasonCode": "RESPONSE_MISMATCH"
              },
              "ServerId": "rg-bp1bfa08ex*****",
              "ServerIp": "192.168.8.10",
              "Status": "Initial"
            }
          ],
          "ServerGroupId": "vsp-bp1qjwo61pqz3ahltv****",
          "ActionType": "TrafficMirror"
        }
      ]
    }
  ],
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "RuleHealthStatus": [
    {
      "RuleId": "rule-hp34s2h0xx1ht4nwo****",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": "on",
          "NonNormalServers": [
            {
              "Port": 90,
              "Reason": {
                "ActualResponse": "302",
                "ExpectedResponse": "HTTP_2xx",
                "ReasonCode": "RESPONSE_MISMATCH"
              },
              "ServerId": "rg-bp1bfa08ex****",
              "ServerIp": "192.168.2.11",
              "Status": "Initial"
            }
          ],
          "ServerGroupId": "vsp-bp1qjwo61pqz3ahlt****",
          "ActionType": "TrafficMirror"
        }
      ]
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	Forbidden.LoadBalancer	Authentication is failed for %s.	Authentication is failed for %s.
404	ResourceNotFound.LoadBalancer	The specified resource %s is not found.	The specified resource %s is not found.
404	ResourceNotFound.Listener	The specified resource %s is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.