调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-waf:DescribeRuleGroups | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SourceIp | string | 否 | 请求源 ip。无需填写,系统自动获取。 | 60.208.*.* |
Lang | string | 否 | 返回消息的语言类型。取值:
| zh |
PageSize | integer | 否 | 分页查询时,每页的行数。默认值为 10。 | 10 |
CurrentPage | integer | 否 | 分页查询时,当前页的页码。默认值为 1。 | 1 |
WafLang | string | 否 | 返回消息的语言类型。取值:
| ZH |
Type | integer | 否 | 规则组类型。取值:
| 10 |
PolicyId | long | 否 | 规则组 ID,仅支持单个输入。 | 1011 |
InstanceId | string | 是 | WAF 实例的 ID。
您可以调用 DescribeInstanceInfo 查询当前 WAF 实例的 ID。
| waf_cdnsdf3**** |
Region | string | 否 | 地域 ID。取值:
| cn |
ResourceGroupId | string | 否 | WAF 实例在资源管理服务中所属的资源组 ID。 不设置该参数表示默认资源组。 | rg-aek2** |
RegionId | string | 否 | WAF 实例所属地域。取值:
| cn-hangzhou |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "02E9A4B8-90FB-5F41-A049-*",
"TaskStatus": 2,
"Total": 1,
"WafTaskId": "123",
"RuleGroups": [
{
"Type": 1,
"RuleCnt": 1,
"RuleGroupUpdateTime": 1711445265,
"PolicyId": 116562,
"Name": "rule_group_test",
"TemplatePolicyId": 1102,
"RuleGroupTemplateName": "rule_group_test",
"Desc": "desc",
"WafVersion": 11,
"DomainList": [
"test.aliyundome.com"
]
}
]
}
错误码
访问错误中心查看更多错误码。