DescribeAntiBruteForceRules - Security Center - Alibaba Cloud Documentation Center

Queries created defense rules against brute-force attacks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	121.69.XX.XX
Id	long	No	The ID of the defense rule. Note You can call the DescribeAntiBruteForceRules operation to query the IDs of defense rules.	1141****
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
PageSize	string	No	The number of entries to return on each page.	10
Name	string	No	The name of the rule.	testName

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	2
Count	integer	The number of entries returned on the current page.	2
Rules	array<object>	An array that consists of the defense rules returned.
AntiBruteForceRule	object	The details about the defense rule.
MachineCount	integer	The number of servers to which the defense rule is applied.	3
EnableSmartRule	boolean	This parameter is deprecated.	false
FailCount	integer	The threshold of logon failures that you specify.	15
ForbiddenTime	integer	The period of time during which logons from an account are not allowed. Unit: minutes.	360
Span	integer	The period of time during which logon failures from an account are measured. Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP address of attackers cannot be used to log on to the server in the specified period of time.	10
DefaultRule	boolean	Indicates whether the defense rule is the default rule. Valid values: true: yes false: no Note The default rule takes effect on all servers that are not protected by defense rules against brute-force attacks.	true
Name	string	The name of the defense rule.	AntiBruteForceRule01
Id	long	The ID of the defense rule.	1629
UuidList	array	An array consisting of the UUIDs of servers to which the defense rule is applied.
uuid	string	The UUID of the server to which the defense rule is applied.	uuid-018c-4ef7-89fd-988b9b0e****
CreateTimestamp	long	防暴力破解规则创建时间戳。单位：毫秒。	1669800181000
ProtocolType	object	The types of protocols that the brute force cracking rule supports to intercept.
Rdp	string	RDP interception method, values: on: enable off: disable	on
Ssh	string	SSH interception method, with values: on: enabled off: disabled	on
SqlServer	string	SqlServer interception mode, with values: on: enable off: disable	off

Examples

Sample success responses

JSONformat

{
  "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,
      "ProtocolType": {
        "Rdp": "on",
        "Ssh": "on",
        "SqlServer": "off"
      }
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-06-08	The response structure of the API has changed	View Change Details
2023-04-06	The request parameters of the API has changed. The response structure of the API has changed	View Change Details