CreateWaitingRoomEvent - Edge Security Acceleration - Alibaba Cloud Documentation Center

Creates a waiting room event.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:CreateWaitingRoomEvent	create	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	Yes	The website ID, which can be obtained by calling the ListSites operation.	123456****
WaitingRoomId	string	No	The ID of the waiting room, which can be obtained by calling the ListWaitingRooms operation.	6a51d5bc6460887abd1291dc7d4db28b
Enable	string	Yes	Specifies whether to enable the waiting room. Valid values: on off	on
Name	string	Yes	The name of the waiting room event.	waitingroom_example
TotalActiveUsers	string	Yes	The maximum number of active users.	100
NewUsersPerMinute	string	Yes	The maximum number of new users per minute.	10
SessionDuration	string	Yes	The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.	5
DisableSessionRenewalEnable	string	No	Specifies whether to disable session renewal. Valid values: on off	on
QueuingMethod	string	Yes	The queuing method. Valid values: random: Users gain access to the origin randomly, regardless of the arrival time. fifo: Users gain access to the origin in order of arrival. passthrough: Users pass through the waiting room and go straight to the origin. reject-all: Users are blocked from reaching the origin.	random
QueuingStatusCode	string	Yes	The HTTP status code to return while a user is in the queue. Valid values: 200 202 429	202
JsonResponseEnable	string	No	Specifies whether to enable JSON response. If you set this parameter to on, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values: on off	on
Description	string	No	The description of the waiting room.
WaitingRoomType	string	Yes	The type of the waiting room. Valid values: default custom	default
CustomPageHtml	string	No	The content of the custom waiting room page. You must specify this parameter if you set WaitingRoomType to custom. The content must be Base64-encoded.	Hello%20world!
StartTime	string	Yes	The start time of the event. This value is a UNIX timestamp.	1719763200
EndTime	string	Yes	The end time of the event. This value is a UNIX timestamp.	1719849600
PreQueueEnable	string	No	Specifies whether to enable pre-queuing. on off	on
PreQueueStartTime	string	No	The start time for pre-queuing.	1719763200
RandomPreQueueEnable	string	No	Specifies whether to enable random queuing. on off	on
Language	string	No	The language of the waiting room page. You must specify this parameter if you set WaitingRoomType to default. Valid values: enus: English. zhcn: Simplified Chinese. zhhk: Traditional Chinese.	zhcn

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A123425345

Examples

Sample success responses

JSONformat

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A123425345"
}

Error codes

HTTP status code	Error code	Error message	Description
400	CompileRuleError	Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document.	Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.
400	SiteConfigLengthExceedLimit	The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K.	The size of the site configuration exceeds the limit, and the total size cannot exceed 512K.
400	ConfigConflicts	Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations.	The parameter uniqueness check failed. Check for duplicate parameter values.
400	FunctionConflict	The feature configuration conflicts. Sites with version management enabled cannot configure this feature.	The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.
400	RuleRegexQuotaCheckFailed	When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan.	The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.
400	NestedRuleQuotaCheckFailed	The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan.	The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.
400	ArgQuotaCheckFailed	The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan.	The current plan does not support the configuration of restricted parameters, please check the input parameters.
400	FunctionQuotaCheckFailed	The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site.	The current plan does not support the configuration of restricted functions, please check the plan related function description.
400	ConfExceedLimit	The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function.	The number of configuration items for the current function has exceeded the upper limit set by the system.
400	ServiceInvokeFailed	The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.	Failed to call the service. Please try again later or contact customer service for details.
400	MissingParameter	The specified ArgName is required for this function.	When configuring a specific function, the required parameter is missing.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	InvalidParameter.ArgName	Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.	Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.
400	InvalidParameter.ArgValue	Invalid parameter value. Check whether the value format and length meet the requirements.	Invalid parameter value. Check whether the value format and length meet the requirements.
400	InstanceNotExist	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.	The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
400	LockFailed	The system is handling requests you previously submitted. Try again later.	The system is handling requests you previously submitted. Try again later.
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.	Your plan is unavailable due to an overdue payment. Complete the payment first.
404	SiteNotFound	The website does not exist or does not belong to you.	The website does not exist or does not belong to you.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-02-12	The Error code has changed. The response structure of the API has changed	View Change Details