All Products
Search
Document Center

Security Center:DescribeBruteForceRecords

Last Updated:Nov 25, 2024

Queries the IP addresses that are blocked by a defense rule 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.

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:DescribeBruteForceRecordslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPageintegerNo

The number of the page to return.

1
StatusintegerNo

The status of the defense rule. Valid values:

  • 0: invalid
  • 1: enabled
  • 2: failed
1
BlockIpstringNo

The IP address that is blocked.

175.106.XX.XX
PageSizeintegerNo

The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. We recommend that you do not leave this parameter empty.

20
InstanceIdstringNo

The ID of the server.

i-bp1g6wxdwps7s9dz****
RemarkstringNo

The name or IP address of the server to query.

1.2.XX.XX

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

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

7E0618A9-D5EF-4220-9471-C42B5E92719F
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page. Default value: 20.

20
TotalCountinteger

The total number of entries returned.

263
Countinteger

The number of entries returned on the current page.

10
MachineListarray<object>

The IP addresses.

BruteForceRecordobject

The information about the IP address.

Statusinteger

The status of the defense rule. Valid values:

  • 0: invalid
  • 1: enabled
  • 2: failed
2
BlockExpireDatelong

The timestamp when the block action on the IP address becomes invalid.

1671506882063
Uuidstring

The UUID of the server on which the defense rule takes effect.

6d5b361f-958d-48a8-a9d2-d6e82c1****
InternetIpstring

The public IP address.

120.79.XX.XX
InstanceNamestring

The instance name of the server.

record-test-***
BlockIpstring

The IP address that is blocked.

10.12.XX.XX
Portstring

The port that is attacked.

22/22
Sourcestring

The type of the defense rule. Valid values:

  • userRule: custom rule
  • blinkRule: system rule
userRule
IntranetIpstring

The private IP address.

192.168.XX.XX
Idlong

The ID of the primary key that is recorded in the defense rule.

112XX
RuleNamestring

The name of the defense rule.

AntiRuleName
ErrorCodestring

The error code returned when the defense rule fails to block the IP address.

InstanceSecurityGroupLimitExceeded
BlockTypestring

The blocking type. Valid values:

  • group: security group
  • alinet: host network extension
alinet
AliNetOnlineboolean

The status of the host network extension. Valid values:

  • true: online
  • false: offline
false

Examples

Sample success responses

JSONformat

{
  "RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 263,
    "Count": 10
  },
  "MachineList": [
    {
      "Status": 2,
      "BlockExpireDate": 1671506882063,
      "Uuid": "6d5b361f-958d-48a8-a9d2-d6e82c1****\n",
      "InternetIp": "120.79.XX.XX",
      "InstanceName": "record-test-***",
      "BlockIp": "10.12.XX.XX",
      "Port": "22/22",
      "Source": "userRule",
      "IntranetIp": "192.168.XX.XX",
      "Id": 0,
      "RuleName": "AntiRuleName",
      "ErrorCode": "InstanceSecurityGroupLimitExceeded",
      "BlockType": "alinet",
      "AliNetOnline": false
    }
  ]
}

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
2024-04-22The request parameters of the API has changedView Change Details
2023-04-06The response structure of the API has changedView Change Details