Queries the anti-brute-force-attack rules that you have created.

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 Sample response Description
PageInfo Struct

The information returned.

Count Integer 2

The number of entries returned on the current page.

CurrentPage Integer 1

The page number of the returned page. Pages start from 1.

PageSize Integer 20

The number of entries returned per page.

TotalCount Integer 2

The total number of anti-brute-force-attack rules that you have created.

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

The ID of the request.

Rules Array of AntiBruteForceRule

The details of the anti-brute-force-attack rule.

DefaultRule Boolean true

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

  • true: yes.
  • false: no.
Note The default rule is applied to all the servers where no anti-brute-force-attack rule is applied.
EnableSmartRule Boolean false

N/A

FailCount Integer 15

The maximum number of allowed logon failures specified in the rule.

ForbiddenTime Integer 360

The duration when logons are disabled after the rule takes effect. Unit: minute.

Id Long 1629

The ID of the anti-brute-force-attack rule.

MachineCount Integer 3

The number of servers to which the anti-brute-force-attack rule is applied.

Name String Alibaba Cloud best practices for anti-brute-force attacks.

The name of the anti-brute-force-attack rule.

Span Integer 10

The time threshold specified in the rule. Unit: minute.

For example, assume that the value of Span is 10. If the number of logon failures within 10 minutes exceeds the specified threshold, logons are disabled for a specified time period.

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

The UUID list of servers to which the 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 for anti-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 for anti-brute-force attacks"
	}],
	"requestId": "6AC2CE6A-12DF-4311-8C7E-B2FDEA7BA39A"
}

Error codes

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