GetLoadBalancer - Edge Security Acceleration - Alibaba Cloud Documentation Center

Mengambil detail load balancer tertentu berdasarkan ID situs dan ID load balancer yang ditentukan.

Deskripsi operasi

API ini memungkinkan Anda untuk mengkueri detail konfigurasi load balancer tertentu dengan menyediakan informasi otentikasi yang diperlukan dan identitas Sumber daya. Detail tersebut mencakup namun tidak terbatas pada nama, kebijakan persistensi sesi, dan kebijakan load balancing.

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

get

*Site

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Id	integer	Yes	ID load balancer, yang secara unik mengidentifikasi load balancer yang akan dikueri. ID ini dikembalikan saat load balancer dibuat. Anda juga dapat memanggil operasi ListLoadBalancers untuk mendapatkan semua load balancer di bawah sebuah situs.	99867648760****
SiteId	integer	Yes	ID situs. Anda dapat memanggil operasi ListSites untuk mendapatkan ID situs.	1159101787****

Elemen respons

Element	Type	Description	Example
	object	Struktur data yang dikembalikan saat tanggapan berhasil, yang berisi konfigurasi detail load balancer.
RequestId	string	ID permintaan.	EEEBE525-F576-1196-8DAF-2D70CA3F4D2F
Id	integer	ID unik load balancer.	99867648760****
Name	string	Nama load balancer.	lb.example.com
SiteId	integer	ID situs tempat load balancer berada.	11591017874****
Enabled	boolean	Apakah load balancer diaktifkan. true: Diaktifkan. false: Tidak diaktifkan.	true
Ttl	integer	Nilai TTL, yang menentukan pengatur waktu hidup (time-to-live) Rekaman DNS. Nilai default: 30 detik.	60
SessionAffinity	string	Pengaturan persistensi sesi. Nilai valid: off: dinonaktifkan. ip: Persistensi sesi berbasis IP. cookie: Persistensi sesi berbasis cookie. http_header: Persistensi sesi berbasis Header HTTP.	ip
FallbackPool	integer	ID pool fallback. Ketika semua pool lain tidak tersedia, trafik dialihkan ke pool ini.	96228666776****
SteeringPolicy	string	Kebijakan load balancing.	order
Description	string	Deskripsi load balancer.	test
AdaptiveRouting	object	Konfigurasi back-to-origin lintas asal (cross-origin).
FailoverAcrossPools	boolean	Apakah failover lintas pool asal diaktifkan. true: Diaktifkan. false: Tidak diaktifkan.	true
OriginLevelRetry	boolean	Apakah akan mencoba kembali alamat IP berikutnya ketika back-to-origin gagal dan server asal adalah nama domain yang resolves ke beberapa alamat IP.	false
DefaultPools	array	Daftar ID pool default.
	integer	Pool default.	96228666776****
RandomSteering	object	Konfigurasi weighted round-robin, yang mengontrol bobot distribusi trafik di berbagai pool.
DefaultWeight	integer	Bobot round-robin default yang diterapkan ke semua pool yang tidak memiliki bobot yang ditentukan secara individual. Nilai valid: 0 hingga 100.	50
PoolWeights	object	Konfigurasi bobot untuk setiap pool server backend. Kuncinya adalah ID pool dan nilainya adalah koefisien bobot. Koefisien bobot mewakili proporsi relatif distribusi trafik.
	integer	Bobot satu pool asal. Nilai valid: 0 hingga 100. Nilai 0 menunjukkan bahwa tidak ada trafik yang dirutekan ke pool asal ini.	50
Rules	array<object>	Daftar konfigurasi aturan yang mendefinisikan perilaku dalam kondisi tertentu.
	array<object>	Konfigurasi aturan dalam set aturan.
FixedResponse	object	Konten tanggapan tetap yang dikembalikan ketika aturan cocok.
ContentType	string	The value for the `Content-Type` HTTP response header.	application/json
Location	string	The value for the `Location` HTTP response header.	http://www.example.com/index.html
MessageBody	string	The content of the response body.	Hello World.
StatusCode	integer	The HTTP status code.	200
Overrides	any	Override konfigurasi load balancing yang diterapkan pada permintaan yang cocok. Bidang yang dikonfigurasi menimpa bidang yang sesuai dalam konfigurasi load balancer.	{ "adaptive_routing": { "failover_across_pools": true }, "sub_region_pools": { "GB": [ 96228666776** ], "US": [ 96228666776 ] }, "default_pools": [ 96228666776, 96228666776 ], "fallback_pool": 96228666776, "location_strategy": { "mode": "resolver_ip", "prefer_ecs": "always" }, "random_steering": { "default_weight": 30, "pool_weights": { "96228666776": 70, "96228666776": 80 } }, "region_pools": { "ENAM": [ 96228666776, 92843536908 ], "WNAM": [ 92843536908** ] }, "session_affinity": "cookie", "session_affinity_attributes": { "drain_duration": 100, "headers": ["none"], "require_all_headers": false, "samesite": "Auto", "secure": "Auto", "zero_downtime_failover": "sticky" }, "session_affinity_ttl": 1800, "steering_policy": "dynamic_latency", "ttl": 30 }
Rule	string	Konten aturan, yang menggunakan ekspresi kondisional untuk mencocokkan permintaan pengguna. Parameter ini tidak diperlukan saat Anda menambahkan konfigurasi global. Dua skenario didukung: Mencocokkan semua permintaan masuk: Atur nilai menjadi true. Mencocokkan permintaan tertentu: Atur nilai menjadi ekspresi kustom, seperti (http.host eq "video.example.com").	http.request.uri.path contains "/testing"
RuleName	string	Nama aturan. Parameter ini tidak diperlukan saat Anda menambahkan konfigurasi global.	r2
RuleEnable	string	Sakelar aturan. Parameter ini tidak diperlukan saat Anda menambahkan konfigurasi global. Nilai valid: on: diaktifkan. off: dinonaktifkan.	off
Sequence	integer	Pesanan eksekusi aturan. Nilai yang lebih besar menunjukkan prioritas yang lebih tinggi.	1
Terminates	boolean	Apakah akan menghentikan tugas eksekusi aturan berikutnya. true: Ya. false: Tidak. Ini adalah nilai default.	true
Monitor	object	Konfigurasi monitor.
Type	string	Jenis protokol monitor, seperti HTTP, yang digunakan untuk pemeriksaan kesehatan. Nilai off menunjukkan bahwa tidak ada pemeriksaan kesehatan yang dilakukan.	HTTP
Method	string	Metode pemeriksaan kesehatan.	GET
Port	integer	Port target.	80
Path	string	Path.	/
Interval	integer	Interval pemeriksaan kesehatan. Unit: detik.	60
ExpectedCodes	string	Kode status yang diharapkan untuk tanggapan HTTP yang berhasil, seperti 200,202.	200,202
FollowRedirects	boolean	Apakah akan mengikuti pengalihan (redirects). true: Ya. false: Tidak.	true
ConsecutiveUp	integer	Jumlah probe berhasil berturut-turut yang diperlukan untuk menganggap pemeriksaan berhasil, seperti `3`.	3
ConsecutiveDown	integer	Jumlah probe gagal berturut-turut yang diperlukan untuk menganggap pemeriksaan gagal, seperti `5`.	5
Header	any	Informasi Header HTTP yang disertakan dalam permintaan probe.	{ "host": [ "example1.com", "example2.com" ] }
Timeout	integer	Periode pengatur waktu pemeriksaan kesehatan. Unit: detik.	5
MonitoringRegion	string	Wilayah tempat node probe berada. Nilai default: Global. Global: seluruh dunia. ChineseMainland: daratan Tiongkok. OutsideChineseMainland: seluruh dunia (kecuali daratan Tiongkok).	Global
Status	string	Status load balancer.	healthy
SubRegionPools	any	Pool yang dipetakan ke wilayah sekunder. Ketika beberapa wilayah sekunder berbagi set pool yang sama, Anda dapat menggabungkan beberapa wilayah sekunder dengan koma sebagai kunci.	{"AL,MO": [92298024898**],"CN-SH,CN-SX,CN-SC":[92304347804,92843536908**]}
RegionPools	any	Pool yang dipetakan ke wilayah utama.	{ "ENAM": [ 12345678** ], "WNAM": [ 23456789, 23456789** ] }

Contoh

Respons sukses

JSONformat

{
  "RequestId": "EEEBE525-F576-1196-8DAF-2D70CA3F4D2F",
  "Id": 0,
  "Name": "lb.example.com",
  "SiteId": 0,
  "Enabled": true,
  "Ttl": 60,
  "SessionAffinity": "ip",
  "FallbackPool": 0,
  "SteeringPolicy": "order",
  "Description": "test",
  "AdaptiveRouting": {
    "FailoverAcrossPools": true,
    "OriginLevelRetry": false
  },
  "DefaultPools": [
    0
  ],
  "RandomSteering": {
    "DefaultWeight": 50,
    "PoolWeights": {
      "key": 50
    }
  },
  "Rules": [
    {
      "FixedResponse": {
        "ContentType": "application/json",
        "Location": "http://www.example.com/index.html",
        "MessageBody": "Hello World.",
        "StatusCode": 200
      },
      "Overrides": "{\n            \"adaptive_routing\": {\n                \"failover_across_pools\": true\n            },\n            \"sub_region_pools\": {\n                \"GB\": [\n                    96228666776****\n                ],\n                \"US\": [\n                    96228666776****\n                ]\n            },\n            \"default_pools\": [\n                96228666776****,\n                96228666776****\n            ],\n            \"fallback_pool\": 96228666776****,\n            \"location_strategy\": {\n                \"mode\": \"resolver_ip\",\n                \"prefer_ecs\": \"always\"\n            },\n            \"random_steering\": {\n                \"default_weight\": 30,\n                \"pool_weights\": {\n                    \"96228666776****\": 70,\n                    \"96228666776****\": 80\n                }\n            },\n            \"region_pools\": {\n                \"ENAM\": [\n                    96228666776****,\n                    92843536908****\n                ],\n                \"WNAM\": [\n                    92843536908****\n                ]\n            },\n            \"session_affinity\": \"cookie\",\n            \"session_affinity_attributes\": {\n                \"drain_duration\": 100,\n                \"headers\": [\"none\"],\n                \"require_all_headers\": false,\n                \"samesite\": \"Auto\",\n                \"secure\": \"Auto\",\n                \"zero_downtime_failover\": \"sticky\"\n            },\n            \"session_affinity_ttl\": 1800,\n            \"steering_policy\": \"dynamic_latency\",\n            \"ttl\": 30\n        }",
      "Rule": "http.request.uri.path contains \"/testing\"",
      "RuleName": "r2",
      "RuleEnable": "off",
      "Sequence": 1,
      "Terminates": true
    }
  ],
  "Monitor": {
    "Type": "HTTP",
    "Method": "GET",
    "Port": 80,
    "Path": "/",
    "Interval": 60,
    "ExpectedCodes": "200,202",
    "FollowRedirects": true,
    "ConsecutiveUp": 3,
    "ConsecutiveDown": 5,
    "Header": "{\n        \"host\": [\n            \"example1.com\",\n            \"example2.com\"\n        ]\n    }",
    "Timeout": 5,
    "MonitoringRegion": "Global"
  },
  "Status": "healthy",
  "SubRegionPools": "{\"AL,MO\": [92298024898****],\"CN-SH,CN-SX,CN-SC\":[92304347804****,92843536908****]}",
  "RegionPools": "{\n  \"ENAM\": [\n    12345678****\n  ],\n  \"WNAM\": [\n    23456789****,\n    23456789****\n  ]\n}"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Pemanggilan layanan gagal. Coba lagi nanti atau hubungi layanan pelanggan untuk detail lebih lanjut.
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.	ID load balancing yang ditentukan tidak ada. Konfirmasi ID tersebut dan coba lagi.
404	SiteNotFound	The website does not exist or does not belong to you.	Situs tidak ada atau bukan milik Anda.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.