ListWaitingRoomRules - 查询等候室绕过规则列表

更新时间:
复制 MD 格式

查询等候室对应的等候室绕过规则列表。

接口说明

此 API 允许用户查询与特定站点关联的等候室绕过规则列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

esa:ListWaitingRoomRules

list

*Site

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

请求参数

名称

类型

必填

描述

示例值

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:开启。

  • off:关闭。

on

Rule

string

规则内容,使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景:

  • 匹配所有传入请求:值设置为 true

  • 匹配指定请求:值设置为自定义表达式,例如:(http.host eq "video.example.com")

(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. 指定的站点不存在或当前未被系统识别。请检查站点标识符是否准确,并确保它与一个已定义、当前活跃且在系统公认的站点网络中可访问的站点相匹配。如果该站点是预定新增的,请确保已完成适当的创建或注册流程,以将其整合到系统中。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情