SwitchSchedulerRule - Anti-DDoS - Alibaba Cloud Documentation Center

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.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RuleName	string	Yes	The name of the scheduling rule to manage. Note You can call the DescribeSchedulerRules operation to query the names of all scheduling rules.	testrule
RuleType	integer	Yes	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
SwitchData	string	Yes	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 elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	7E3C301F-84BB-50E4-9DB9-2937B2429C1E

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.