All Products
Search
Document Center

Anti-DDoS:SwitchSchedulerRule

Last Updated:Jan 29, 2024

Switches service traffic to your Anti-DDoS Pro or Anti-DDoS Premium instance for scrubbing or switches service traffic back to the associated cloud resources.

Operation description

You can call the SwitchSchedulerRule operation to modify the resources to which service traffic is switched for a scheduling rule. For example, you can switch service traffic to an Anti-DDoS Pro or Anti-DDoS Premium instance for scrubbing or switch the service traffic back to the associated cloud resources.

Before you call this operation, you must have created a scheduling rule by calling the CreateSchedulerRule operation.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-ddoscoo:SwitchSchedulerRuleWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RuleNamestringYes

The name of the scheduling rule to manage.

Note You can call the DescribeSchedulerRules operation to query the names of all scheduling rules.
testrule
RuleTypeintegerYes

The type of the scheduling rule. Valid values:

  • 2: tiered protection rule
  • 3: network acceleration rule
  • 5: Alibaba Cloud CDN (CDN) interaction rule
  • 6: cloud service interaction rule
6
SwitchDatastringYes

The configuration that is used to switch service traffic. This parameter is a string that consists of JSON arrays. Each element in a JSON array is a JSON struct that includes the following parameters:

  • Value: required. The IP address of the associated resource. Data type: string.

  • State: required. The operation type. Data type: integer. Valid values:

    • 0: switches service traffic from the associated resource to your Anti-DDoS Pro or Anti-DDoS Premium instance for scrubbing.
    • 1: switches service traffic back to the associated cloud resource.
  • Interval: optional. The waiting time that is required before the service traffic is switched back. Unit: minutes. Data type: integer. Usage notes:

    • If the State parameter is set to 0, you must set this parameter to **-1**. Otherwise, the call fails.
    • If the State parameter is set to 1, you do not need to set this parameter.
[{"Value":"39.104.XX.XX","State":0,"Interval":-1}]

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

7E3C301F-84BB-50E4-9DB9-2937B2429C1E

Examples

Sample success responses

JSONformat

{
  "RequestId": "7E3C301F-84BB-50E4-9DB9-2937B2429C1E"
}

Error codes

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