Overview ListWaitingRooms API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Mengkueri detail semua ruang tunggu yang dikonfigurasi untuk situs tertentu.

Deskripsi operasi

API ini memungkinkan Anda mengkueri detail konfigurasi semua ruang tunggu untuk situs tertentu, termasuk status aktif, nama, dan aturan antrian.

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

list

*Situs.

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	ID situs. Anda dapat memanggil operasi ListSites untuk mendapatkan ID situs.	120876698010528
WaitingRoomId	string	No	ID ruang tunggu. Tentukan parameter ini untuk mengkueri detail ruang tunggu tertentu.	6a51d5bc6460887abd1291dc7d4d****

Elemen respons

Element	Type	Description	Example
	object	Tanggapan kueri.
RequestId	string	ID permintaan, yang digunakan untuk menjejak panggilan API.	CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
WaitingRooms	array<object>	Daftar ruang tunggu.
	array<object>	Detail ruang tunggu.
WaitingRoomId	string	ID ruang tunggu, yang secara unik mengidentifikasi sebuah ruang tunggu.	6a51d5bc6460887abd1291dc7d4d****
Enable	string	Status aktif. Nilai valid: on: Aktif. off: Nonaktif.	on
Name	string	Nama ruang tunggu.	Test waiting room
QueueAllEnable	string	Apakah akan memasukkan semua pengunjung ke Antrian. Nilai valid: on: Aktif. off: Nonaktif.	on
HostNameAndPath	array<object>	Konfigurasi hostname dan path.
	object	Detail hostname dan path.
Subdomain	string	Subdomain.	test.
Domain	string	Nama domain.	example.com
Path	string	Jalur.	/test
CookieName	string	Nama cookie kustom.	__aliwaitingroom_example
TotalActiveUsers	string	Jumlah total pengguna aktif.	300
NewUsersPerMinute	string	Jumlah pengguna baru per menit.	200
SessionDuration	string	Durasi sesi, dalam menit.	3600
DisableSessionRenewalEnable	string	Apakah akan menonaktifkan pembaruan sesi. Nilai valid: on: Aktif. off: Nonaktif.	on
QueuingMethod	string	Metode antrian. Nilai valid: random: Acak. fifo: First in, first out. passthrough: Passthrough. reject-all: Tolak semua.	random
QueuingStatusCode	string	Kode status ruang tunggu. Nilai valid: 200 202 429	200
JsonResponseEnable	string	Apakah akan mengaktifkan tanggapan JSON. Jika diaktifkan, permintaan dengan Header Accept yang berisi "application/json" akan mengembalikan data JSON. Nilai valid: on: Aktif. off: Nonaktif.	on
Description	string	Deskripsi ruang tunggu.	Test waiting room
WaitingRoomType	string	Tipe ruang tunggu. Nilai valid: default: Tipe default. custom: Tipe kustom.	default
CustomPageHtml	string	Konten HTML atau pengenal halaman antrian kustom. Parameter ini hanya valid jika WaitingRoomType diatur ke custom. Konten harus di-URL-encode.	Custom HTML content
Language	string	Bahasa halaman ruang tunggu. Parameter ini wajib diisi jika tipe ruang tunggu adalah default. Nilai valid: enus: Bahasa Inggris. zhcn: Bahasa Tionghoa Sederhana. zhhk: Bahasa Tionghoa Tradisional.	zhcn

Contoh

Respons sukses

JSONformat

{
  "RequestId": "CB1A380B-09F0-41BB-A198-72F8FD6DA2FE",
  "WaitingRooms": [
    {
      "WaitingRoomId": "6a51d5bc6460887abd1291dc7d4d****\n",
      "Enable": "on",
      "Name": "Test waiting room",
      "QueueAllEnable": "on",
      "HostNameAndPath": [
        {
          "Subdomain": "test.\n",
          "Domain": "example.com\n",
          "Path": "/test"
        }
      ],
      "CookieName": "__aliwaitingroom_example",
      "TotalActiveUsers": "300",
      "NewUsersPerMinute": "200",
      "SessionDuration": "3600",
      "DisableSessionRenewalEnable": "on",
      "QueuingMethod": "random",
      "QueuingStatusCode": "200",
      "JsonResponseEnable": "on",
      "Description": "Test waiting room",
      "WaitingRoomType": "default",
      "CustomPageHtml": "Custom HTML content",
      "Language": "zhcn"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Gagal memanggil layanan. Coba lagi nanti atau hubungi layanan pelanggan untuk detail lebih lanjut.
403	Site.NotExist	The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.	Situs yang ditentukan tidak ada atau saat ini tidak dikenali oleh sistem. Verifikasi bahwa pengidentifikasi situs akurat dan cocok dengan situs yang didefinisikan, aktif, dan dapat diakses dalam jaringan sistem. Jika situs dimaksudkan untuk ditambahkan baru, pastikan proses pembuatan atau pendaftaran yang sesuai telah diselesaikan untuk mengintegrasikannya ke dalam sistem.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.