分页查询防护规则。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-waf:DescribeDefenseRules | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | WAF 实例 ID。 说明
您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。
| waf_cdnsdf3**** |
RuleType | string | 否 | 防护规则类型。取值:
| whitelist |
Query | string | 否 | 查询条件,以一系列参数构造的 JSON 格式转化成字符串。 说明
根据不同的查询条件,查询到的防护规则结果不同。详细信息,请参见Query 参数描述。
| {\"name\":\"IP压制_20220822_10\",\"scene\":\"custom_acl\",\"templateId\":5327} |
PageNumber | integer | 否 | 分页查询时,返回第几页数据。默认值为 1,表示返回第 1 页数据。 | 1 |
PageSize | integer | 否 | 分页查询时,每页包含多少条结果。默认值为 10,表示每页包含 10 条结果。 | 10 |
RegionId | string | 否 | WAF 实例所属地域。取值:
| cn-hangzhou |
ResourceManagerResourceGroupId | string | 否 | 阿里云资源组 ID。 | rg-acfm***q |
Query 参数详解
参数描述
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
name | String | 可选 | test | 要查询的防护规则名称。您可以设置该参数,精确查询某条防护规则。 |
nameId | String | 可选 | test1 | 要查询的防护规则 ID 或名称。您可以设置该参数,模糊查询某条防护规则。 |
nameLike | String | 可选 | test.aliyundoc.c | 要查询的防护规则名称。您可以设置该参数,模糊查询某条防护规则。 |
scene | String | 可选 | waf_group | 要查询的防护场景。您可以设置该参数,精确查询某个防护场景的防护规则。取值范围请参见 CreateDefenseRule 的 DefenseScene 参数。 |
ruleId | Long | 可选 | 33444 | 要查询的防护规则 ID。您可以设置该参数,精确查询某条防护规则。 |
ruleIdIn | Array | 可选 | [3334455643,345555] | 要查询的防护规则 ID 范围。您可以设置该参数,查询多个防护规则。多个防护规则之间使用英文逗号(,)分隔。 |
templateId | Long | 可选 | 24354 | 要查询的防护模板 ID。您可以设置该参数,查询某个防护模板中的防护规则。 |
orderBy | String | 可选 | name | 设置防护规则排序方式。取值: - name : 表示按防护规则名称排序。 - gmtModified : 表示按防护规则修改时间排序。 - id : 表示按规则 ID 排序。 - templateId : 表示按防护模板 ID 排序。 |
desc | Boolean | 可选 | true | 设置排序顺序。取值: - false : 表示正序显示。 - true : 表示倒序显示。 |
示例
{
"name": "test",
"nameId ": "test1,
"nameLike": "test.aliyundoc.c",
"nameIn": "test.aliyundoc.c",
"InstaneId": "test1.aliyundoc.com,test2.aliyundoc.com",
"templateId": 24354
}
返回参数
示例
正常返回示例
JSON
格式
{
"TotalCount": 2,
"RequestId": "80736FA5-FA87-55F6-AA69-C5477C6FE6D0",
"Rules": [
{
"Status": 1,
"DefenseOrigin": "custom",
"Config": "{\\\"policyId\\\":1012,\\\"action\\\":\\\"block\\\"}",
"RuleId": 42755,
"DefenseScene": "waf_group",
"GmtModified": 1665460629000,
"RuleName": "rules_41",
"TemplateId": 5673
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史