コンテンツにスキップ

API コマンド

Cloudflare Waiting Room は、トラフィックが多いウェブページにアクセスしようとする訪問者を仮想待機室にリダイレクトします。

Cloudflare Waiting Room API は、待機室をプログラムで管理するためのインターフェースを提供します。

リクエスト URL 形式

Cloudflare Waiting Room API 操作を呼び出すには、エンドポイントを Cloudflare API ベース URL に追加します:

Terminal window
https://api.cloudflare.com/client/v4

認証手順については、Cloudflare API ドキュメントの Getting Started: Requests を参照してください。

エンドポイントやページネーションに関するヘルプについては、Getting Started: Endpoints を参照してください。

待機室の管理

操作メソッド + URL スタブノート
待機室の一覧GET zones/{:zone_identifier}/waiting_roomsゾーンのすべての待機室を一覧表示します。
待機室の作成POST zones/{:zone_identifier}/waiting_rooms待機室を作成します。
待機室の詳細GET zones/{:zone_identifier}/waiting_rooms/{:identifier}待機室を取得します。
待機室の更新PUT zones/{:zone_identifier}/waiting_rooms/{:identifier}待機室を更新します。
待機室の削除DELETE zones/{:zone_identifier}/waiting_rooms/{:identifier}待機室を削除します。
待機室のパッチPATCH zones/{:zone_identifier}/waiting_rooms/{:identifier}設定された待機室をパッチします。

待機室の現在のステータスを取得

操作メソッド + URL スタブノート
待機室の現在のステータスを取得GET zones/{:zone_identifier}/waiting_rooms/{:identifier}/status
  • キューがアクティブな場合は queueing を返します(クライアントは待機室に入れられます)。
  • キューがアクティブでない場合、または待機室が一時停止している場合は not_queueing を返します。