All Products
Search
Document Center

Security Center:CreateAntiBruteForceRule

Last Updated:Jan 28, 2023

Creates a defense rule against brute-force attacks.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

192.168.XX.XX
NamestringYes

The name of the defense rule.

TestAntiBruteForceRule
SpanintegerYes

The maximum period of time during which failed logon attempts from an account can occur. Unit: minutes. Valid values:

  • 1
  • 2
  • 5
  • 10
  • 15
NoteTo configure a defense rule, you must specify the Span, FailCount, and ForbiddenTime parameters. If the number of failed logon attempts from an account within the minutes specified by Span exceeds the value specified by FailCount, the account cannot be used for logons within the minutes specified by ForbiddenTime.
1
FailCountintegerYes

The maximum number of failed logon attempts from an account. Valid values: 2, 3, 4, 5, 10, 50, 80, and 100.

2
ForbiddenTimeintegerYes

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

  • 5: 5 minutes
  • 15: 15 minutes
  • 30: 30 minutes
  • 60: 1 hour
  • 120: 2 hours
  • 360: 6 hours
  • 720: 12 hours
  • 1440: 24 hours
  • 10080: 7 days
  • 52560000: permanent
5
DefaultRulebooleanNo

Specifies whether to set the defense rule as the default rule. Valid values:

  • true: yes
  • false: no
NoteIf no defense rule is created for a server, the default rule is applied to the server.
true
UuidListarrayYes

The UUIDs of the servers to which you want to apply the defense rule.

stringNo

The UUID of the server to which you want to apply the defense rule.

292dcc68-b60b-4bbd-a0be-beaa1622****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

F35F45B0-5D6B-4238-BE02-A62D0760E840
CreateAntiBruteForceRuleobject

The information about the defense rule.

RuleIdlong

The ID of the defense rule.

65778

Example

Normal return example

JSONFormat

{
  "RequestId": "F35F45B0-5D6B-4238-BE02-A62D0760E840",
  "CreateAntiBruteForceRule": {
    "RuleId": 65778
  }
}

Error codes

Http codeError codeError messageDescription
400NotBuyuser not buy serviceUser not buy service.
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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