Stop ALB Listener Traffic via StopListener API - Application Load Balancer

Deskripsi operasi

StopListener adalah operasi asinkron. Setelah permintaan dikirim, sistem mengembalikan ID permintaan dan menjalankan tugas di latar belakang. Anda dapat memanggil operasi GetListenerAttribute untuk memeriksa status tugas tersebut:

Jika listener berada dalam status Configuring, listener sedang dinonaktifkan.
Jika listener berada dalam status Stopped, listener telah dinonaktifkan.

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

update

*LoadBalancer

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	ID listener Application Load Balancer (ALB).	lsr-bp1bpn0kn908w4nbw****
ClientToken	string	No	Token client yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan client untuk menghasilkan token tersebut, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Token hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan request ID sebagai client token. Request ID mungkin berbeda untuk setiap permintaan.	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRun	boolean	No	Menentukan apakah hanya melakukan dry run tanpa menjalankan permintaan sebenarnya. Nilai yang valid: true: hanya melakukan dry run. Sistem memeriksa permintaan terhadap potensi masalah, termasuk nilai parameter yang hilang, sintaksis permintaan yang salah, dan batas layanan. Jika permintaan gagal dalam dry run, pesan kesalahan akan dikembalikan. Jika permintaan lolos dry run, kode kesalahan `DryRunOperation` akan dikembalikan. false (default): melakukan dry run dan menjalankan permintaan sebenarnya. Jika permintaan lolos dry run, kode status HTTP `2xx` dikembalikan dan operasi dilakukan.	true

Elemen respons

Element	Type	Description	Example
	object	Operasi untuk menonaktifkan listener.
JobId	string	ID tugas asinkron.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	ID permintaan.	365F4154-92F6-4AE4-92F8-7FF34B540710

Contoh

Respons sukses

JSONformat

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	The business status of %s [%s] is incorrect.
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.
400	ResourceInConfiguring.Listener	The specified resource of %s is being configured, please try again later.	The specified resource of %s is being configured, please try again later.
404	ResourceNotFound.Listener	The specified resource %s is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.