Configure Waiting Room Rules via API - Edge Security Acceleration

Updates a waiting room.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:UpdateWaitingRoom

update

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The website ID, which can be obtained by calling the ListSites operation.	7096621098****
WaitingRoomId	string	Yes	The ID of the waiting room, which can be obtained by calling the ListWaitingRooms operation.	6a51d5bc6460887abd129****
Enable	string	No	Specifies whether to enable the waiting room. Valid values: on off	on
Name	string	No	The name of the waiting room.	节假日促销等候室
QueueAllEnable	string	No	Specifies whether to queue all requests. Valid values: on off	on
HostNameAndPath	array<object>	No	The hostname and path.
	object	No	The details of the hostname and path.
Subdomain	string	No	The subdomain.	test.
Domain	string	No	The domain name.	example.com
Path	string	No	The probe path.	/test
CookieName	string	No	The name of the custom cookie.	__aliwaitingroom_example
TotalActiveUsers	string	No	The maximum number of active users.	300
NewUsersPerMinute	string	No	The maximum number of new users per minute.	200
SessionDuration	string	No	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	No	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	No	The HTTP status code to return while a user is in the queue. Valid values: 200 202 429	200
JsonResponseEnable	string	No	Specifies whether to enable JSON response. If JSON response is enabled, 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	No	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.	SGVsbG8gd29ybGQ=
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 elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0195619f-eab3-4a66-ac00-ed53d913e72e

Examples

Success response

JSON format

{
  "RequestId": "0195619f-eab3-4a66-ac00-ed53d913e72e"
}

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	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	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	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	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	WaitingRoomNotExist	The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again.	The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again.
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	QuotaCheckFailed.FunctionArg	The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.	The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.
404	SiteNotFound	The website does not exist or does not belong to you.	The website does not exist or does not belong to you.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.