All Products
Search

This Product

    Anti-DDoS:CreateSchedulerRule

    Document Center

    Anti-DDoS:CreateSchedulerRule

    Last Updated:Aug 06, 2026

    Creates a Sec-Traffic Manager rule.

    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-ddoscoo:CreateSchedulerRule

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ResourceGroupId

    string

    No

    The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.

    default
    Rules

    string

    Yes

    The details of the general interaction rule. This parameter is a JSON string that consists of the following characters. The following list describes the structure:

    • Type: String type. Required. The format of the Resource for Interaction address. Valid values:

      • A: IP address

      • CNAME: domain name

    • Value: String type. Required. The address of the Resource for Interaction.

    • Priority: Integer type. Required. The priority of the rule. Valid values: 0 to 100. A larger value indicates a higher priority.

    • ValueType: Integer type. Required. The type of the Resource for Interaction. Valid values:

      • 1: IP Address of Anti-DDoS Proxy instance

      • 2: (Tiered protection) IP addresses of cloud resources

      • 3: (Sec-acceleration for China-to-global traffic) acceleration line IP address

      • 5: (CDN interaction) acceleration domain name

      • 6: (Cloud service interaction) IP addresses of cloud resources

    • RegionId: String type. Optional (required when ValueType is 2). The region ID.

    [{"Type":"A", "Value":"1.1.XX.XX", "Priority":80,"ValueType":2, "RegionId":"cn-hangzhou" },{"Type":"A", "Value":"203.199.XX.XX", "Priority":80,"ValueType":1}]
    RuleName

    string

    Yes

    The name of the rule.

    testrule
    RuleType

    integer

    Yes

    The type of the rule. Valid values:

    • 2: tiered protection

    • 3: acceleration for China-to-global traffic

    • 5: CDN interaction

    • 6: cloud service interaction

    • 8: secure acceleration

    2
    Param

    string

    No

    The details of the CDN interaction rule. This parameter is a JSON format character string. The following list describes the structure:

    • ParamType: Required. String type. The type of CDN interaction. Valid values: cdn, which indicates CDN interaction.

    • ParamData: Required. Map type. The CDN interaction parameters. The following list describes the structure:

      • Domain: Required. String type. The CDN-accelerated domain name.

      • Cname: Required. String type. The CNAME of the accelerated domain name.

      • AccessQps: Required. Integer type. The access QPS threshold. If the QPS exceeds this threshold, traffic is switched to Anti-DDoS Pro and Anti-DDoS Premium.

      • UpstreamQps: Optional. Integer type. The back-to-origin QPS threshold. If the QPS is lower than this threshold, traffic is switched to CDN.

    {"ParamType":"cdn","ParamData":{"Domain":"example.aliyundoc.com","Cname":"demo.aliyundoc.com","AccessQps":100,"UpstreamQps":100}}

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request. The value is a unique identifier that Alibaba Cloud generates for the request. You can use this ID to troubleshoot issues.

    8DFB602D-1AAC-46C4-90F2-C84086E7A6E4
    Cname

    string

    The CNAME assigned by Sec-Traffic Manager for the rule.

    Note

    You must map your service domain name to the CNAME of Sec-Traffic Manager to enable the rule.

    48k7b372gpl4****.aliyunddos0001.com
    RuleName

    string

    The name of the rule.

    testrule

    Examples

    Success response

    JSON format

    {
  "RequestId": "8DFB602D-1AAC-46C4-90F2-C84086E7A6E4",
  "Cname": "48k7b372gpl4****.aliyunddos0001.com",
  "RuleName": "testrule"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.