Monitor Kesehatan GWLB Listener secara Real Time melalui API - Server Load Balancer

Menanyakan Status pemeriksaan kesehatan listener Gateway Load Balancer (GWLB).

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

gwlb:GetListenerHealthStatus

get

*LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadbalancerId}

*Listener

acs:gwlb:{#regionId}:{#accountId}:listener/{#ListenerId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	ID listener.	lsn-7sixpvm5fc3v0b****
NextToken	string	No	Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Nilai yang valid: Jika NextToken kosong, tidak ada halaman berikutnya. Jika nilai NextToken dikembalikan, nilai tersebut menunjukkan token yang digunakan untuk kueri berikutnya.	4f1d7cc9f51e18904e8a063603a6b0c3d03bc69f78734254e0b5e8707e68****
MaxResults	integer	No	Jumlah entri per halaman. Nilai yang valid: 1 hingga 1000. Nilai default: 20.	20
Skip	integer	No	Jumlah entri yang dilewati dalam panggilan ini.	10
Filter	array<object>	No	Kondisi filter. Anda dapat menentukan maksimal 20 kondisi filter.
	object	No	Kondisi filter.
Name	string	No	Nama kondisi filter. Anda dapat memfilter berdasarkan satu atau beberapa nama kondisi filter. URL harus memenuhi persyaratan berikut: Status: status kesehatan. ReasonCode: penyebab server tidak sehat. ServerId: ID server backend. ServerIp: alamat IP server backend.	Status
Values	array	No	Nilai kondisi filter. Anda dapat menentukan maksimal 20 nilai kondisi.
	string	No	Nilai kondisi filter. Nilai yang valid bervariasi tergantung pada nama kondisi filter yang ditentukan dalam respons.	Unhealthy

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
ListenerHealthStatus	array<object>	Status pemeriksaan kesehatan dari kelompok server yang terkait dengan listener.
	array<object>	Status pemeriksaan kesehatan dari kelompok server yang terkait dengan listener.
ListenerId	string	ID listener.	lsn-sg8aha6pzjavvo****
ServerGroupInfos	array<object>	Informasi tentang kelompok server.
	array<object>	Informasi tentang kelompok server.
HealthCheckEnabled	boolean	Menunjukkan apakah fitur Pemeriksaan kesehatan diaktifkan. Nilai yang valid: true false	true
ServerGroupId	string	ID kelompok server.	sgp-0vdsbyszro3nr6****
Servers	array<object>	Server backend.
	array<object>	Server backend.
Port	integer	Port backend.	6081
Reason	object	Alasan mengapa Status menunjukkan status tidak sehat.
ReasonCode	string	Alasan mengapa Status menunjukkan status tidak sehat. Nilai yang valid: CONNECT_TIMEOUT: Instans GWLB gagal terhubung ke server backend dalam periode waktu yang ditentukan. CONNECT_FAILED: Instans GWLB gagal terhubung ke server backend. RECV_RESPONSE_TIMEOUT: Instans GWLB gagal menerima tanggapan dari server backend dalam periode waktu yang ditentukan. CONNECT_INTERRUPT: Koneksi antara pemeriksaan kesehatan dan server backend terputus. HTTP_CODE_NOT_MATCH: Kode status HTTP dari server backend tidak sesuai dengan yang diharapkan. HTTP_INVALID_HEADER: Format tanggapan dari server backend tidak valid.	CONNECT_TIMEOUT
ServerId	string	ID server backend.	i-2ze4rnh8yj9kif3z****
ServerIp	string	Alamat IP server.	192.168.0.XXX
Status	string	Status kesehatan server backend. Nilai yang valid: Initial: Pemeriksaan kesehatan dikonfigurasikan untuk instans GWLB, tetapi tidak ditemukan data. Unhealthy: Server backend gagal berturut-turut dalam pemeriksaan kesehatan. Unused: Server backend tidak sedang digunakan. Unavailable: Pemeriksaan kesehatan dinonaktifkan. Healthy: Server backend dalam kondisi sehat.	Healthy
MaxResults	integer	Jumlah entri per halaman. Nilai yang valid: 1 hingga 1000. Nilai default: 20.	20
NextToken	string	Token paginasi. Dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Nilai yang valid: Jika NextToken kosong, tidak ada halaman berikutnya. Jika nilai NextToken dikembalikan, nilai tersebut menunjukkan token yang digunakan untuk kueri berikutnya.	U12WEI6Ro2ol3wA54rBNSwdC5+lYy6q5SjIQEvc1wz5mjZxV+YjsHRdXV8XauY1BpOQIvwX63E0en54H3D****
RequestId	string	ID permintaan.	0ED4F222-36A0-5470-8A9A-AAB4E96BAC1A
TotalCount	integer	Jumlah total entri yang dikembalikan.	31

Contoh

Respons sukses

JSONformat

{
  "ListenerHealthStatus": [
    {
      "ListenerId": "lsn-sg8aha6pzjavvo****",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": true,
          "ServerGroupId": "sgp-0vdsbyszro3nr6****",
          "Servers": [
            {
              "Port": 6081,
              "Reason": {
                "ReasonCode": "CONNECT_TIMEOUT"
              },
              "ServerId": "i-2ze4rnh8yj9kif3z****",
              "ServerIp": "192.168.0.XXX",
              "Status": "Healthy"
            }
          ]
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "U12WEI6Ro2ol3wA54rBNSwdC5+lYy6q5SjIQEvc1wz5mjZxV+YjsHRdXV8XauY1BpOQIvwX63E0en54H3D****",
  "RequestId": "0ED4F222-36A0-5470-8A9A-AAB4E96BAC1A",
  "TotalCount": 31
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalParam.FilterValue	The param of %s is illegal.	The parameter of FilterValue is illegal.
400	IllegalParam.FilterName	The param of %s is illegal.	The parameter of FilterName is illegal.
404	ResourceNotFound.Listener	The specified resource of %s is not found.	The specified resource of %s is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.