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

Usage notes

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SwitchSchedulerRule

The operation that you want to perform. Set the value to SwitchSchedulerRule.

RuleName String Yes testrule

The name of the scheduling rule to manage.

Note You can call the DescribeSchedulerRules operation to query the names of all scheduling rules.
RuleType Integer Yes 6

The type of the scheduling rule. Valid values:

  • 2: tiered protection rule
  • 3: network acceleration rule
  • 5: CDN interaction rule
  • 6: cloud service interaction rule
SwitchData String Yes [{"Value":"39.104.XX.XX","State":0,"Interval":-1}]

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

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

Parameter Type Example Description
RequestId String 7E3C301F-84BB-50E4-9DB9-2937B2429C1E

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=SwitchSchedulerRule
&RuleName=testrule
&RuleType=6
&SwitchData=[{"Value":"39.104.XX.XX","State":0,"Interval":-1}]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<SwitchSchedulerRuleResponse>
    <RequestId>7E3C301F-84BB-50E4-9DB9-2937B2429C1E</RequestId>
</SwitchSchedulerRuleResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.