ListWaitingRoomRules - 查询等候室绕过规则列表
查询等候室对应的等候室绕过规则列表。
接口说明
此 API 允许用户查询与特定站点关联的等候室绕过规则列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
esa:ListWaitingRoomRules |
list |
*Site
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SiteId |
integer |
是 |
站点 ID,可通过调用 ListSites 接口获取。 |
123456**** |
| WaitingRoomId |
string |
是 |
要绕过的等待室 ID,可通过调用 ListWatingRooms 接口获取。 |
6a51d5bc6460887abd129**** |
| WaitingRoomRuleId |
integer |
否 |
要更新的等候室绕过规则 ID,可通过调用 ListWaitingRoomRules 接口获取。 |
37286782688**** |
| RuleName |
string |
否 |
规则名,可选,用于按等候室绕过规则名称查询。 |
test |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
查询响应结果。 |
||
| RequestId |
string |
请求 ID,用于追踪调用情况。 |
15C66C7B-671A-4297-9187-2C4477247A123425345 |
| WaitingRoomRules |
array<object> |
等候室绕过规则列表。 |
|
|
object |
等候室绕过规则详情。 |
||
| WaitingRoomRuleId |
integer |
规则 ID。 |
37286782688**** |
| RuleName |
string |
规则名称。添加全局配置的时候不需要设置该参数。 |
ip |
| RuleEnable |
string |
规则开关。添加全局配置的时候不需要设置该参数。取值范围:
|
on |
| Rule |
string |
规则内容,使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景:
|
(http.request.uri.path.file_name eq \"jpg\") |
示例
正常返回示例
JSON格式
{
"RequestId": "15C66C7B-671A-4297-9187-2C4477247A123425345",
"WaitingRoomRules": [
{
"WaitingRoomRuleId": 0,
"RuleName": "ip",
"RuleEnable": "on",
"Rule": "(http.request.uri.path.file_name eq \\\"jpg\\\")"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InternalException | 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. | 指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确,并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的,请确保已完成适当的创建或注册流程,以将其整合到系统中。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。