statuses
Creates, updates, deletes, gets or lists a statuses resource.
Overview
| Name | statuses |
| Type | Resource |
| Id | cloudflare.waiting_rooms.statuses |
Fields
The following fields are returned by SELECT queries:
- list
Get waiting room status response
| Name | Datatype | Description |
|---|---|---|
event_id | string | (example: 25756b2dfe6e378a06b033b670413757) |
estimated_queued_users | integer | |
estimated_total_active_users | integer | |
max_estimated_time_minutes | integer | |
status | string | (event_prequeueing, not_queueing, queueing, suspended) (example: queueing) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | waiting_room_id, zone_id | Fetches the status of a configured waiting room. Response fields include: 1. status: String indicating the status of the waiting room. The possible status are: - not_queueing indicates that the configured thresholds have not been met and all users are going through to the origin. - queueing indicates that the thresholds have been met and some users are held in the waiting room. - event_prequeueing indicates that an event is active and is currently prequeueing users before it starts. - suspended indicates that the room is suspended. 2. event_id: String of the current event's id if an event is active, otherwise an empty string. 3. estimated_queued_users: Integer of the estimated number of users currently waiting in the queue. 4. estimated_total_active_users: Integer of the estimated number of users currently active on the origin. 5. max_estimated_time_minutes: Integer of the maximum estimated time currently presented to the users. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
waiting_room_id | string | The Waiting Room ID. |
zone_id | string | The Cloudflare zone ID. |
SELECT examples
- list
Fetches the status of a configured waiting room. Response fields include: 1. status: String indicating the status of the waiting room. The possible status are: - not_queueing indicates that the configured thresholds have not been met and all users are going through to the origin. - queueing indicates that the thresholds have been met and some users are held in the waiting room. - event_prequeueing indicates that an event is active and is currently prequeueing users before it starts. - suspended indicates that the room is suspended. 2. event_id: String of the current event's id if an event is active, otherwise an empty string. 3. estimated_queued_users: Integer of the estimated number of users currently waiting in the queue. 4. estimated_total_active_users: Integer of the estimated number of users currently active on the origin. 5. max_estimated_time_minutes: Integer of the maximum estimated time currently presented to the users.
SELECT
event_id,
estimated_queued_users,
estimated_total_active_users,
max_estimated_time_minutes,
status
FROM cloudflare.waiting_rooms.statuses
WHERE waiting_room_id = '{{ waiting_room_id }}' -- required
AND zone_id = '{{ zone_id }}' -- required
;