List Waiting Room Bypass Rules with ListWaitingRoomRules - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Operation description

Queries the waiting room bypass rules associated with a specific site.

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

list

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	Site ID. You can call the ListSites operation to obtain the site ID.	123456****
WaitingRoomId	string	Yes	The waiting room ID. You can call the ListWaitingRooms operation to obtain the waiting room ID.	6a51d5bc6460887abd129****
WaitingRoomRuleId	integer	No	The waiting room bypass rule ID. You can call the ListWaitingRoomRules operation to obtain the rule ID.	37286782688****
RuleName	string	No	The rule name. If specified, filters results by rule name.	test

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A123425345
WaitingRoomRules	array<object>	The list of waiting room bypass rules.
	object	The details of a waiting room bypass rule.
WaitingRoomRuleId	integer	The rule ID.	37286782688****
RuleName	string	The rule name. You do not need to set this parameter when adding a global configuration.	ip
RuleEnable	string	The rule switch. You do not need to set this parameter when adding a global configuration. Valid values: on: enabled. off: disabled.	on
Rule	string	The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when adding a global configuration. Valid values: Match all incoming requests: set the value to true. Match specific requests: set the value to a custom expression, such as (http.host eq "video.example.com").	(http.request.uri.path.file_name eq \"jpg\")

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.