跳转到内容
搜索文档

创建 Waiting Room

最后更新 查看 MarkdownAgent 设置

您可以从仪表板或通过 API 创建 Waiting Room。

  1. 在您的应用程序内,转到 Traffic(流量) > Waiting Room(等候室)
  2. 选择 Create(创建)
  3. 为您的 Waiting Room 自定义 设置。如需更多指导,请参考 最佳实践
  4. 选择 Next(下一步)
  5. 在本部分中,您可以选择是否为 Waiting Room 启用 Turnstile。如果选择 Yes(是),您需要选择 小组件模式 并定义 Turnstile 质询失败时要采取的操作。可用的小组件模式和操作取决于您的计划类型。有关更多详细信息,请参考 计划
  6. 如果您希望 自定义您的 Waiting Room,请根据需要更新 HTML 和 CSS。如果您使用此 Waiting Room 来管理移动应用程序或 API 的流量,请启用 JSON 响应切换。确保已为您的客户端(移动端或 Web 应用程序)设置了 JSON 友好响应
  7. 选择 Queuing status code(排队状态代码) 以确定用户在 Waiting Room 时返回的 HTTP 状态代码。
  8. 选择 Next(下一步)
  9. 在保存之前检查您的设置。如果您自定义了 Waiting Room,请确保 预览结果
  10. 选择 Save(保存)。您的新 Waiting Room 默认将被启用。

要使用 API 创建 Waiting Room,请向 /zones/{zone_identifier}/waiting_rooms 端点发送 POST 请求

Required API token permissions

At least one of the following token permissions is required:
  • Waiting Rooms Write
Create waiting roombash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/waiting_rooms" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"name": "shop_waiting_room",
		"description": "Waiting room for webshop",
		"host": "shop.example.com",
		"path": "/shop",
		"queue_all": true,
		"new_users_per_minute": 200,
		"total_active_users": 300,
		"session_duration": 1,
		"disable_session_renewal": false,
		"json_response_enabled": false,
		"queueing_method": "fifo",
		"queueing_status_code": 202,
		"cookie_attributes": {
				"samesite": "auto",
				"secure": "auto"
		}
	}'

响应包含新创建的 Waiting Room 的完整定义。

响应json
{
	"success": true,
	"errors": [],
	"messages": [],
	"result": [
		{
			"id": "1111111111111111111111",
			"created_on": "2023-01-01T05:20:00.12345Z",
			"modified_on": "2023-01-01T05:20:00.12345Z",
			"name": "shop_waiting_room",
			"description": "Waiting room for webshop",
			"host": "shop.example.com",
			"path": "/shop",
			"queue_all": true,
			"new_users_per_minute": 200,
			"total_active_users": 300,
			"session_duration": 1,
			"disable_session_renewal": false,
			"json_response_enabled": false,
			"queueing_method": "fifo",
			"queueing_status_code": 202,
			"cookie_attributes": {
				"samesite": "auto",
				"secure": "auto"
			}
		}
	]
}

这篇文档对您有帮助吗?