Monitor Kesehatan Origin Load Balancer melalui API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Deskripsi operasi

Query the status of origins under load balancers. You can pass multiple load balancer IDs at once, separated by commas. This is for load balancers that have monitors configured. It will probe the origins in the source address pools used by the load balancers and record the current status of each origin.

Healthy(healthy): The probe result is available.
Unhealthy(unhealthy): The probe result is unavailable.
Unknown(unknown): Unknown, the monitor has not yet probed.
Undetected(undetected): The load balancer to which the origin belongs is not bound to a monitor.

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

esa:ListLoadBalancerOriginStatus

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	ID situs.	1159101787****
LoadBalancerIds	string	Yes	ID load balancer. Pisahkan beberapa ID dengan koma. Anda dapat menentukan hingga 100 ID load balancer dalam satu pengatur waktu. Anda dapat memperoleh ID load balancer dengan memanggil operasi ListLoadBalancers.	99874066052**,100892832360**
PoolType	string	No	Tipe kolam origin. Load balancer dapat memiliki beberapa kolam origin yang dikonfigurasi, termasuk kolam default, kolam fallback, dan kolam wilayah utama. Hanya status origin di kolam default yang memengaruhi status load balancer itu sendiri. Atur parameter ini ke `default_pool` untuk mengkueri hanya status origin di kolam origin default load balancer.	default_pool

Elemen respons

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID, used for tracking the request.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
OriginStatus	array<object>	List of origin statuses under the load balancer.
	object	Information about the origin status.
LoadBalancerId	integer	ID of the load balancer.	99874066052****
OriginId	integer	ID of the origin.	99750209487****
PoolId	integer	ID of the source address pool.	99750209487****
Status	string	Status of the origin: Healthy(healthy): The probe result is available. Unhealthy(unhealthy): The probe result is unavailable. Unknown(unknown): Unknown, the monitor has not yet probed. Undetected(undetected): The load balancer to which the origin belongs is not bound to a monitor.	healthy
Reason	string	Reason for the probe failure.	TCP connection error
PoolType	string	The origin pool to which the source belongs, under this load balancer. Only 'default_pool' (default address pool) will be displayed; other types will return an empty string.	default_pool

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "OriginStatus": [
    {
      "LoadBalancerId": 0,
      "OriginId": 0,
      "PoolId": 0,
      "Status": "healthy",
      "Reason": "TCP connection error",
      "PoolType": "default_pool"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	LoadBalancerNotExist	The specified load balancer name is invalid or load balancing is not enabled for your website.Make sure that you specify a valid load balancer name and load balancing is enabled. Then, try again.	The specified load balancer name is invalid or load balancing is not enabled for your website.Make sure that you specify a valid load balancer name and load balancing is enabled. Then, try again.
404	SiteNotFound	The website does not exist or does not belong to you.	The website does not exist or does not belong to you.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.