查询BOT管理规则标签信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
WAF 实例 ID。 说明
您可以通过调用 DescribeInstance 接口查看您当前 WAF 实例 ID。 |
waf_v3prepaid_public_cn-53y4****** |
| SubScene |
string |
否 |
Bot 管理防护场景类型。取值:
|
app |
| ResourceManagerResourceGroupId |
string |
否 |
阿里云资源组 ID。 |
rg-acfm***q |
| RegionId |
string |
否 |
WAF 实例所属地域。取值:
|
cn-hangzhou |
| LabelType |
string |
否 |
要查询 BOT 规则标签类型。 |
human_machine_challenge |
| NextToken |
string |
否 |
下一页查询凭证(Token),如果有下一页,则该字段有返回值。 说明
该参数只要返回值,则说明还有下一页。您可以将返回的 NextToken 作为请求参数再次获得下一页的数据,直到无返回值,表示获取到了所有的数据。 |
AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS |
| MaxResults |
integer |
否 |
分页查询时每页个数。取值范围为:1-200,默认值为 20。 |
20 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
本次请求的 ID。 |
D7861F61-5B61-46CE-A47C-6B19****5EB0 |
| RuleLabels |
array<object> |
BOT 管理的规则标签列表。 |
|
|
object |
|||
| LabelKey |
string |
BOT 管理的规则标签。 |
malicious_crawler_python |
| SubScene |
string |
规则属于的 Bot 管理防护场景的集合,多个场景用英文逗号(,)隔开。取值:
|
Web,app |
| BotBehavior |
string |
规则标签对应的爬虫行为。
|
malicious |
| LabelType |
string |
BOT 规则标签类型。 |
human_machine_challenge |
| NextToken |
string |
下一页查询凭证(Token),如果有下一页,则该字段有返回值。 说明
该参数只要返回值,则说明还有下一页。您可以将返回的 NextToken 作为请求参数再次获得下一页的数据,直到无返回值,表示获取到了所有的数据。 |
AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS |
| MaxResults |
integer |
分页查询时每页个数。取值范围为:1-200,默认值为 20。 |
20 |
| TotalCount |
integer |
返回结果的总数。 |
8 |
示例
正常返回示例
JSON格式
{
"RequestId": "D7861F61-5B61-46CE-A47C-6B19****5EB0",
"RuleLabels": [
{
"LabelKey": "malicious_crawler_python",
"SubScene": "Web,app",
"BotBehavior": "malicious",
"LabelType": "human_machine_challenge"
}
],
"NextToken": "AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS",
"MaxResults": 20,
"TotalCount": 8
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。