DescribeAntiBruteForceRules API Reference - Security Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query the list of anti-brute force rules

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 IP address of the access source.	121.69.XX.XX
Id	long	No	The ID of the anti-brute force rule. Note You can obtain this parameter by calling the DescribeAntiBruteForceRules interface.	1141****
CurrentPage	integer	No	Set which page of the returned results to start displaying the query results. The default value is 1, indicating that the display starts from the first page.	1
PageSize	string	No	The maximum number of data entries displayed per page during a paginated query.	10
Name	string	No	The name of the brute force rule.	testName

Response parameters

Parameter	Type	Description	Example
	object	Request return data.
RequestId	string	The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request and can be used for troubleshooting and problem localization.	4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D
PageInfo	object	Pagination information of the query result.
CurrentPage	integer	The page number of the current page during a paginated query.	1
PageSize	integer	The maximum number of data entries displayed per page during a paginated query.	20
TotalCount	integer	The total number of created anti-brute force rules.	2
Count	integer	The number of data entries displayed on the current page during a paginated query.	2
Rules	array<object>	List of details of the anti-brute force rules.
AntiBruteForceRule	object	Details of the anti-brute force rule.
MachineCount	integer	The number of servers configured with this brute force defense rule.	3
EnableSmartRule	boolean	This parameter is deprecated and does not need to be considered.	false
FailCount	integer	The threshold for the number of failed login attempts before the brute force defense rule takes effect.	15
ForbiddenTime	integer	The duration (in minutes) for which the attacker's IP is disabled after the brute force defense rule takes effect.	360
Span	integer	The time threshold (in minutes) for the brute force defense rule to take effect. For example, if span is 10, it means that if the number of failed login attempts exceeds the set threshold within 10 minutes, the anti-brute force rule will take effect and block logins for a specified period.	10
DefaultRule	boolean	Whether the current rule is the default rule. Values: true: It is the default rule. false: It is not the default rule. Note A default anti-brute force rule will apply to all servers that do not have a defense rule added.	true
Name	string	Name of the brute force attack defense rule.	AntiBruteForceRule01
Id	long	The ID of the anti-brute force rule.	1629
UuidList	array	A list of UUIDs for the servers that have this anti-brute force rule configured.
uuid	string	The UUID of a server that has this anti-brute force rule configured.	uuid-018c-4ef7-89fd-988b9b0e****
CreateTimestamp	long	The timestamp when the anti-brute force rule was created. Unit: milliseconds.	1669800181000
ProtocolType	object	The types of protocols supported by the anti-brute force rule for interception.
Rdp	string	RDP interception method, with values: on: Enabled off: Disabled	on
Ssh	string	SSH interception method, with values: on: Enabled off: Disabled	on
SqlServer	string	SQL Server interception method, with values: on: Enabled off: Disabled	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