Control Traffic Queuing with Waiting Room Rules via API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Creates a waiting room bypass rule.

Operation description

Your site plan must be Enterprise Edition or higher to use this feature, and the site plan must support this feature.

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:CreateWaitingRoomRule

create

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. You can call the ListSites operation to obtain the site ID.	123456****
WaitingRoomId	string	Yes	The ID of the waiting room to bypass.	25133f536f1b1f6b6091f6a92c614dd4
RuleName	string	Yes	The rule name. This parameter is not required when you add a global configuration.	waitingroom_example
RuleEnable	string	Yes	Specifies whether to enable the rule. This parameter is not required when you add a global configuration. Valid values: on: enabled. off: disabled.	on
Rule	string	Yes	The rule content. Use a conditional expression to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported: Match all incoming requests: Set the value to true. Match specified requests: Set the value to a custom expression, for example, (http.host eq "video.example.com"). For the complete syntax of rule expressions, refer to https://www.alibabacloud.com/help/edge-security-acceleration/esa/user-guide/work-with-rules-engine/	(http.request.uri.path.file_name eq \"jpg\")

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	EEEBE525-F576-1196-8DAF-2D70CA3F4D2F
WaitingRoomRuleId	integer	The ID of the waiting room bypass rule.	420072638347264

Examples

Success response

JSON format

{
  "RequestId": "EEEBE525-F576-1196-8DAF-2D70CA3F4D2F",
  "WaitingRoomRuleId": 420072638347264
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The specified ArgName is required for this function.	When configuring a specific function, the required parameter is missing.
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	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.