调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| yundun-waf:DescribeRules | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SourceIp | string | 否 | 请求源 IP。无需填写，系统自动获取。 | 42.84.*.* |
| PageSize | integer | 否 | 分页查询时，每页的行数。默认值为 10。 | 10 |
| PageNumber | integer | 否 | 当前页码。默认值：1。 | 1 |
| RuleIdKey | string | 否 | 规则的 id，支持模糊查询 | 1131*0 |
| CveIdKey | string | 否 | CVE ID | CVE-*-*5 |
| ProtectionType | integer | 否 | 防护类型。取值如下：
| 11 |
| ApplicationType | integer | 否 | 应用类型。取值如下：
| 0 |
| RiskLevel | integer | 否 | 要查询的检查项风险等级。取值：
| 0 |
| RuleGroupId | long | 是 | 正则规则组 ID | 1012 |
| Lang | string | 否 | 设置规则名称的语言属性，取值：
| zh |
| InstanceId | string | 是 | WAF 实例 ID。 说明
您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。
| waf-cn-* |
| Region | string | 否 | 地域 ID。取值：
| cn |
| ResourceGroupId | string | 否 | WAF 实例在资源管理服务中所属的资源组 ID。默认为空，即属于默认资源组。 关于资源组的更多信息，请参见创建资源组。 | rg-* |
| RegionId | string | 否 | WAF 实例所属地域。取值：
| cn-hangzhou |
返回参数
示例
正常返回示例
JSON格式
{
"RuleGroupTemplateId": "1012",
"RuleGroupName": "test111",
"RequestId": "D7861F61-5B61-46CE-A47C-*",
"TotalCount": 1,
"RuleGroupTemplateName": "rule_group_test",
"IsSubscribe": 1,
"Rules": [
{
"RiskLevel": 0,
"UpdateTime": 1684120148,
"Description": "默认",
"CveUrl": "https://avd.aliyun.com/",
"ApplicationType": 15,
"CveId": "CVE-2021-*",
"ProtectionType": 11,
"RuleName": "rules_41",
"RuleId": 42755
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||
|---|---|---|---|---|
| 2024-05-27 | API 内部配置变更，不影响调用 | 看变更集 | ||
|