All Products
Search
Document Center

Security Center:DescribeBruteForceSummary

Last Updated:Nov 25, 2024

Queries the statistics of IP address blocking policies that are used to defend against brute-force attacks and trigger alerts.

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

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

203.119.XX.XX

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

AE60EAE3-ABD0-897C-B0F16CAC6C7D
BruteForceSummaryobject

The statistics of IP address blocking policies.

AllStrategyCountinteger

The number of anti-brute force IP blocking policies.

13
EffectiveCountinteger

The number of anti-brute force IP blocking policies enabled.

2
AntiBruteForceRuleCountstring

The number of defense policies.

2
CustomRecordCountstring

The number of custom blocking rules.

19730
SystemRecordCountstring

The number of system blocking rules.

2
CustomEffectiveCountstring

The number of custom blocking rules that are in effect.

3
SystemEffectiveCountstring

The number of system blocking rules that are in effect.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "AE60EAE3-ABD0-897C-B0F16CAC6C7D",
  "BruteForceSummary": {
    "AllStrategyCount": 13,
    "EffectiveCount": 2,
    "AntiBruteForceRuleCount": "2",
    "CustomRecordCount": "19730",
    "SystemRecordCount": "2",
    "CustomEffectiveCount": "3",
    "SystemEffectiveCount": "1"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionno permission-
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-04-06The Error code has changed. The response structure of the API has changedView Change Details