CreateAntiBruteForceRule - Security Center - Alibaba Cloud Documentation Center

Creates 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:CreateAntiBruteForceRule	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	192.168.XX.XX
Name	string	Yes	The name of the defense rule.	TestAntiBruteForceRule
Span	integer	Yes	The maximum period of time during which failed logon attempts from an account can occur. Unit: minutes. Valid values: 1 2 5 10 15 Note To 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
FailCount	integer	Yes	The maximum number of failed logon attempts from an account. Valid values: 2, 3, 4, 5, 10, 50, 80, and 100.	2
ForbiddenTime	integer	Yes	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
DefaultRule	boolean	No	Specifies whether to set the defense rule as the default rule. Valid values: true: yes false: no Note If no defense rule is created for a server, the default rule is applied to the server.	true
UuidList	array	Yes	The UUIDs of the servers to which you want to apply the defense rule.
	string	Yes	The UUID of the server to which you want to apply the defense rule.	292dcc68-b60b-4bbd-a0be-beaa1622****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	F35F45B0-5D6B-4238-BE02-A62D0760E840
CreateAntiBruteForceRule	object	The information about the defense rule.
RuleId	long	The ID of the defense rule.	65778

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	NotBuy	user not buy service	User not buy service.
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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