All Products
Search

This Product

    Anti-DDoS:DescribeSchedulerRules

    Document Center

    Anti-DDoS:DescribeSchedulerRules

    Last Updated:Nov 05, 2025

    Queries the scheduling rules of Sec-Traffic Manager.

    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:DescribeSchedulerRules

    get

    *All Resource

    *

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    ResourceGroupId

    string

    No

    The resource group ID of the Anti-DDoS Proxy instance in Resource Management. The default value is empty, which indicates that the instance belongs to the default resource group.

    default

    RuleName

    string

    No

    The rule name.

    testrule

    PageNumber

    integer

    No

    The page number of the returned page. For example, to query the results on the first page, enter 1.

    1

    PageSize

    integer

    Yes

    The number of records displayed on each page.

    10

    Response elements

    Parameter

    Type

    Description

    Example

    object

    TotalCount

    string

    The total number of traffic scheduling rules.

    1

    RequestId

    string

    The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem locating.

    11C55595-1757-4B17-9ACE-4ACB68C2D989

    SchedulerRules

    array<object>

    The traffic scheduling rule information.

    object

    RuleType

    string

    The rule type. Valid values:

    • 2: tiered protection

    • 3: network acceleration

    • 5: CDN filter interaction

    • 6: cloud service interaction

    • 8: secure acceleration

    Cname

    string

    The canonical name value.

    4eru5229a843****.aliyunddos0001.com

    RuleName

    string

    The rule name.

    doctest

    Rules

    array<object>

    The rule list.

    object

    Type

    string

    The format of the resource address. Valid values:

    • A: IPv4 address

    • CNAME: canonical name address

    A

    Status

    integer

    The rule status. Valid values:

    • 0: inactive

    • 1: active

    0

    Value

    string

    The resource address.

    203.***.***.39

    ValueType

    integer

    The resource address type. Valid values:

    • 1: Anti-DDoS Proxy IP

    • 2: (tiered protection) cloud resource IP

    • 3: (network acceleration) MCA IP

    • 5: (CDN filter interaction) accelerated domain name

    • 6: (cloud service interaction) cloud resource IP

    • 8: (CMA) secure acceleration P

    1

    Priority

    integer

    The rule priority.

    100

    RestoreDelay

    integer

    The Waiting Time of Switchback, in minutes.

    60

    RegionId

    string

    The region ID.

    Note

    This parameter is returned only when RuleType is set to 2 (tiered protection rule).

    1

    Line

    string

    Param

    object

    The rule for Global Accelerator instance interaction with Anti-DDoS Proxy.

    ParamType

    string

    The type of Resource for Interaction. Valid value: GA, which indicates a Global Accelerator instance.

    GA

    ParamData

    object

    The Resource for Interaction.

    CloudInstanceId

    string

    The ID of the Global Accelerator instance.

    ga-bp1htlajy5509rc99****

    Examples

    Success response

    JSON format

    {
  "TotalCount": "1",
  "RequestId": "11C55595-1757-4B17-9ACE-4ACB68C2D989",
  "SchedulerRules": [
    {
      "RuleType": "2",
      "Cname": "4eru5229a843****.aliyunddos0001.com",
      "RuleName": "doctest",
      "Rules": [
        {
          "Type": "A",
          "Status": 0,
          "Value": "203.***.***.39",
          "ValueType": 1,
          "Priority": 100,
          "RestoreDelay": 60,
          "RegionId": "1",
          "Line": ""
        }
      ],
      "Param": {
        "ParamType": "GA",
        "ParamData": {
          "CloudInstanceId": "ga-bp1htlajy5509rc99****"
        }
      }
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.