All Products
Search
Document Center

Security Center:DescribeBruteForceSummary

Last Updated:Jan 28, 2023

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

203.119.XX.XX

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

AE60EAE3-ABD0-897C-B0F16CAC6C7D
BruteForceSummaryobject

The statistics of IP address blocking policies.

AllStrategyCountinteger

The total number of IP address blocking policies.

13
EffectiveCountinteger

The number of enabled IP address blocking policies.

2

Example

Normal return example

JSONFormat

{
  "RequestId": "AE60EAE3-ABD0-897C-B0F16CAC6C7D",
  "BruteForceSummary": {
    "AllStrategyCount": 13,
    "EffectiveCount": 2
  }
}

Error codes

Http codeError codeError message
400NoPermissionno permission
500ServerErrorServerError

For a list of error codes, visit the API error center.