调用DescribeAntiBruteForceRules接口查询您已创建的防暴力破解规则。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAntiBruteForceRules

需要执行的操作。

取值:DescribeAntiBruteForceRules

SourceIp String 1.2.3.4

访问源的IP地址。

返回数据

名称 类型 示例值 描述
PageInfo Struct

查询结果的分页信息。

Count Integer 2

分页查询时,当前页显示的数据条数。

CurrentPage Integer 1

分页查询时,当前页的页码。

PageSize Integer 20

分页查询时,每页最多显示的数据条数。

TotalCount Integer 2

已创建的防暴力破解规则的总数。

RequestId String 4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D

阿里云为该请求生成的唯一标识符。

Rules Array of AntiBruteForceRule

防暴力破解规则详情,

DefaultRule Boolean true

当前规则是否为默认规则。取值:

  • true:是默认规则。
  • false:不是默认规则。
说明 设置为默认规则的防暴力破解规则会对所有未添加防御规则的服务器生效。
EnableSmartRule Boolean false

该参数已废弃,无需关注。

FailCount Integer 15

暴力破解防御规则生效的用户登录的失败次数阈值。

ForbiddenTime Integer 360

暴力破解防御规则生效后对攻击方IP禁用的时间,单位(分钟)。

Id Long 1629

暴力破解防御规则的规则ID。

MachineCount Integer 3

配置该暴力破解防御规则的服务器数量。

Name String 防暴力破解攻击阿里云最佳实践

暴力破解防御规则的名称。

Span Integer 10

暴力破解防御规则生效的时间阈值,单位为分钟。

例如Span为10,表示如果在10分钟内登录失败次数超过设置的阈值,防暴力破解规则会生效并在指定时间内拦截登录。

UuidList List uuid-b3e-867b-1d56cf4d****", "uuid-d86f-47ea-a75d-c87c9fbfbb51", "uuid-018c-4ef7-89fd-988b9b0e****"

配置该暴力破解防御规则的服务器的UUID列表。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeAntiBruteForceRules
&<公共请求参数>

正常返回示例

XML 格式

<DescribeAntiBruteForceRulesResponse>
      <PageInfo>
            <TotalCount>2</TotalCount>
            <PageSize>20</PageSize>
            <CurrentPage>1</CurrentPage>
            <Count>2</Count>
      </PageInfo>
      <Rules>
            <DefaultRule>false</DefaultRule>
            <ForbiddenTime>360</ForbiddenTime>
            <UuidList>uuid-80d2f7d6-ecc42f8****</UuidList>
            <FailCount>80</FailCount>
            <EnableSmartRule>false</EnableSmartRule>
            <MachineCount>1</MachineCount>
            <Id>1781</Id>
            <Span>10</Span>
            <Name>Test</Name>
      </Rules>
      <Rules>
            <DefaultRule>false</DefaultRule>
            <ForbiddenTime>5</ForbiddenTime>
            <UuidList>uuid-b3e-867b-1d56cf4d****</UuidList>
            <UuidList>uuid-d86f-47ea-a75d-c87c9fbf****</UuidList>
            <UuidList>uuid-018c-4ef7-89fd-988b9b0e****</UuidList>
            <FailCount>5</FailCount>
            <EnableSmartRule>false</EnableSmartRule>
            <MachineCount>3</MachineCount>
            <Id>1629</Id>
            <Span>15</Span>
            <Name>防暴力破解攻击阿里云最佳实践</Name>
      </Rules>
      <requestId>6AC2CE6A-12DF-4311-8C7E-B2FDEA7BA39A</requestId>
</DescribeAntiBruteForceRulesResponse>

JSON 格式

{
	"PageInfo": {
		"TotalCount": 2,
		"PageSize": 20,
		"CurrentPage": 1,
		"Count": 2
	},
	"Rules": [{
		"DefaultRule": false,
		"ForbiddenTime": 360,
		"UuidList": ["uuid-80d2f7d6-ecc42f8****"],
		"FailCount": 80,
		"EnableSmartRule": false,
		"MachineCount": 1,
		"Id": 1781,
		"Span": 10,
		"Name": "Test"
	}, {
		"DefaultRule": false,
		"ForbiddenTime": 5,
		"UuidList": ["uuid-b3e-867b-1d56cf4d****", "uuid-d86f-47ea-a75d-c87c9fbf****", "uuid-018c-4ef7-89fd-988b9b0e****"],
		"FailCount": 5,
		"EnableSmartRule": false,
		"MachineCount": 3,
		"Id": 1629,
		"Span": 15,
		"Name": "防暴力破解攻击阿里云最佳实践"
	}],
	"requestId": "6AC2CE6A-12DF-4311-8C7E-B2FDEA7BA39A"
}

错误码

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