ListWaitingRoomRules - Edge Security Acceleration - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query Waiting Room Bypass Rules

Operation description

This API allows users to query the list of waiting room bypass rules associated with a specific site.

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:ListWaitingRoomRules	list	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	Yes	Site ID, which can be obtained by calling the ListSites interface.	123456****
WaitingRoomId	string	Yes	The ID of the waiting room to bypass, which can be obtained by calling the ListWaitingRooms interface.	6a51d5bc6460887abd129****
WaitingRoomRuleId	long	No	The ID of the waiting room bypass rule to update, which can be obtained by calling the ListWaitingRoomRules interface.	37286782688****
RuleName	string	No	Rule name, optional, used for querying by the name of the waiting room bypass rule.	test

Response parameters

Parameter	Type	Description	Example
	object	Query response result.
RequestId	string	Request ID, used for tracking the call status.	15C66C7B-671A-4297-9187-2C4477247A123425345
WaitingRoomRules	array<object>	List of waiting room bypass rules.
Item	object	Details of the waiting room bypass rule.
WaitingRoomRuleId	long	Rule ID.	37286782688****
RuleName	string	Rule name. This parameter does not need to be set when adding global configuration.	ip
RuleEnable	string	Rule switch. This parameter does not need to be set when adding global configuration. Value range: on: enabled. off: disabled.	on
Rule	string	Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding global configuration. There are two usage scenarios: Match all incoming requests: set the value to true Match specific requests: set the value to a custom expression, e.g., (http.host eq "video.example.com")	(http.request.uri.path.file_name eq \"jpg\")

Examples

Sample success responses

JSONformat

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A123425345",
  "WaitingRoomRules": [
    {
      "WaitingRoomRuleId": 0,
      "RuleName": "ip",
      "RuleEnable": "on",
      "Rule": "(http.request.uri.path.file_name eq \\\"jpg\\\")"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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.
403	Site.NotExist	The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.	The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system.

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

Change history

Change time	Summary of changes	Operation
2024-09-18	The Error code has changed	View Change Details