Queries the defense rules against brute-force attacks that you create.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeAntiBruteForceRules

The operation that you want to perform.

Set the value to DescribeAntiBruteForceRules.

SourceIp String No 1.2.3.4

The source IP address of the request.

Response parameters

Parameter Type Example Description
PageInfo Struct

The pagination information.

Count Integer 2

The number of entries returned on the current page.

CurrentPage Integer 1

The page number of the returned page.

PageSize Integer 20

The number of entries returned per page.

TotalCount Integer 2

The total number of defense rules against brute-force attacks that you create.

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

The ID of the request.

Rules Array of AntiBruteForceRule

The details about the defense rule against brute-force attacks.

DefaultRule Boolean true

Indicates whether the defense rule is the default rule. Valid values:

  • true
  • false
Note A default rule takes effect on all servers that are not protected by defense rules against brute-force attacks.
EnableSmartRule Boolean false

This parameter is deprecated.

FailCount Integer 15

The threshold of logon failures that is specified in the defense rule.

ForbiddenTime Integer 360

The duration in which the IP address of attackers cannot be used to log on to the server on which the defense rule takes effect. Unit: minutes.

Id Long 1629

The ID of the defense rule.

MachineCount Integer 3

The number of servers to which the defense rule is applied.

Name String Alibaba Cloud best practices against brute-force attacks

The name of the defense rule.

Span Integer 10

The time threshold that is used to determine whether the defense rule takes effect. Unit: minutes.

If Span is set to 10, the defense rule takes effect when the logon failures exceeds the specified threshold within 10 minutes. The IP address of attackers cannot be used to log on to the server within the specified duration.

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

The UUIDs of servers to which the defense rule is applied.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeAntiBruteForceRules
&<Common request parameters>

Sample success responses

XML format

<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>Alibaba Cloud best practices against brute-force attacks</Name>
      </Rules>
      <requestId>6AC2CE6A-12DF-4311-8C7E-B2FDEA7BA39A</requestId>
</DescribeAntiBruteForceRulesResponse>

JSON format

{
	"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": "Alibaba Cloud best practices against brute-force attacks"
	}],
	"requestId": "6AC2CE6A-12DF-4311-8C7E-B2FDEA7BA39A"
}

Error codes

For a list of error codes, visit the API Error Center.