All Products
Search

This Product

    Security Center:CreateAntiBruteForceRule

    Document Center

    Security Center:CreateAntiBruteForceRule

    Last Updated:Aug 28, 2026

    Creates a defense rule against brute-force attacks.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-sas:CreateAntiBruteForceRule

    create

    *AntiBruteForceRule

    acs:yundun-sas:{#regionId}:{#accountId}:antibruteforcerule/*

    		 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 time window for monitoring failed logon attempts from an account. Unit: minutes. Valid values:

    • 1

    • 2

    • 5

    • 10

    • 15

    Note

    You must specify Span, FailCount, and ForbiddenTime together. If the number of failed logon attempts within the period specified by Span exceeds FailCount, the account is locked out for the duration 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 duration for which an account is locked out. Unit: minutes. Valid values:

    • 5

    • 15

    • 30

    • 60

    • 120

    • 360

    • 720

    • 1440

    • 10080

    • 52560000: permanent

    5
    DefaultRule

    boolean

    No

    Whether to set this as the default defense rule. Valid values:

    • true: yes

    • false: no

    true
    UuidList

    array

    Yes

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

    string

    No

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

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

    object

    No

    The protocol types supported for brute-force attack interception.

    Rdp

    string

    No

    Whether to enable RDP interception. Default value: on. Valid values:

    • on: Enable

    • off: Disable

    on
    Ssh

    string

    No

    Whether to enable SSH interception. Default value: on. Valid values:

    • on: Enable

    • off: Disable

    on
    SqlServer

    string

    No

    Whether to enable SQL Server interception. Default value: off. Valid values:

    • on: Enable

    • off: Disable

    off

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    F35F45B0-5D6B-4238-BE02-A62D0760E840
    CreateAntiBruteForceRule

    object

    The information about the defense rule.

    RuleId

    integer

    The ID of the defense rule.

    65778

    Examples

    Success response

    JSON format

    {
  "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.
    500 ServerError ServerError
    403 NoPermission caller has no permission You are not authorized to do this operation.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.