All Products
Search
Document Center

Security Center:DescribeAntiBruteForceRules

Last Updated:Feb 20, 2024

Queries created defense rules against brute-force attacks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeAntiBruteForceRulesRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

121.69.XX.XX
IdlongNo

The ID of the defense rule.

Note You can call the DescribeAntiBruteForceRules operation to query the IDs of defense rules.
1141****
CurrentPageintegerNo

The number of the page to return. Default value: 1.

1
PageSizestringNo

The number of entries to return on each page.

10
NamestringNo

The name of the rule.

testName

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

2
Countinteger

The number of entries returned on the current page.

2
Rulesobject []

An array that consists of the details of the defense rule.

MachineCountinteger

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

3
EnableSmartRuleboolean

This parameter is deprecated.

false
FailCountinteger

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

15
ForbiddenTimeinteger

The period of time during which logons from an account are not allowed. Unit: minutes.

360
Spaninteger

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
DefaultRuleboolean

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

  • true: The defense rule is the default rule.
  • false: The defense rule is not the default rule.
Note The default rule takes effect on all servers that are not protected by defense rules against brute-force attacks.
true
Namestring

The name of the defense rule.

AntiBruteForceRule01
Idlong

The ID of the defense rule.

1629
UuidListarray

An array consisting of the UUIDs of servers to which the defense rule is applied.

string

The UUID of the server to which the defense rule is applied.

uuid-018c-4ef7-89fd-988b9b0e****
CreateTimestamplong

The timestamp when the rule was created. Unit: milliseconds.

1669800181000

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
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
2023-06-08The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-04-06The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Name
Output ParametersThe response structure of the API has changed.