DescribeAntiBruteForceRules - 查询已创建的防暴力破解规则 - 云安全中心

查询您已创建的防暴力破解规则。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:DescribeAntiBruteForceRules	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
SourceIp	string	否	访问源的 IP 地址。	121.69.XX.XX
Id	long	否	防暴力破解规则 ID。说明调用 DescribeAntiBruteForceRules 接口可以获取该参数。	1141****
CurrentPage	integer	否	设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。	1
PageSize	string	否	分页查询时，显示的每页数据的最大条数。	10
Name	string	否	暴力破解规则的名称。	testName

返回参数

名称	类型	描述	示例值
	object	请求返回数据。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D
PageInfo	object	查询结果的分页信息。
CurrentPage	integer	分页查询时，当前页的页码。	1
PageSize	integer	分页查询时，每页最多显示的数据条数。	20
TotalCount	integer	已创建的防暴力破解规则的总数。	2
Count	integer	分页查询时，当前页显示的数据条数。	2
Rules	array<object>	防暴力破解规则详情列表。
AntiBruteForceRule	object	防暴力破解规则详情。
MachineCount	integer	配置该暴力破解防御规则的服务器数量。	3
EnableSmartRule	boolean	该参数已废弃，无需关注。	false
FailCount	integer	暴力破解防御规则生效的用户登录的失败次数阈值。	15
ForbiddenTime	integer	暴力破解防御规则生效后对攻击方 IP 禁用的时间，单位（分钟）。	360
Span	integer	暴力破解防御规则生效的时间阈值，单位为分钟。例如 span 为 10，表示如果在 10 分钟内登录失败次数超过设置的阈值，防暴力破解规则会生效并在指定时间内拦截登录。	10
DefaultRule	boolean	当前规则是否为默认规则。取值： true：是默认规则。 false：不是默认规则。说明设置为默认规则的防暴力破解规则会对所有未添加防御规则的服务器生效。	true
Name	string	暴力破解防御规则的名称。	AntiBruteForceRule01
Id	long	暴力破解防御规则的规则 ID。	1629
UuidList	array	配置该暴力破解防御规则的服务器的 UUID 列表。
uuid	string	配置该暴力破解防御规则的服务器的 UUID。	uuid-018c-4ef7-89fd-988b9b0e****
CreateTimestamp	long	防暴力破解规则创建时间戳。单位：毫秒。	1669800181000

示例

正常返回示例

JSON格式

{
  "RequestId": "4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 2,
    "Count": 2
  },
  "Rules": [
    {
      "MachineCount": 3,
      "EnableSmartRule": false,
      "FailCount": 15,
      "ForbiddenTime": 360,
      "Span": 10,
      "DefaultRule": true,
      "Name": "AntiBruteForceRule01",
      "Id": 1629,
      "UuidList": [
        "uuid-018c-4ef7-89fd-988b9b0e****"
      ],
      "CreateTimestamp": 1669800181000
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
403	NoPermission	caller has no permission	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
500	ServerError	ServerError	服务故障，请稍后重试！

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

变更历史

变更时间	变更内容概要	操作
2023-06-08	OpenAPI 返回结构发生变更	查看变更详情
2023-04-06	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情