All Products
Search
Document Center

Anti-DDoS:ConfigSchedruleOnDemand

Last Updated:Apr 10, 2024

Modifies the scheduling rule of an on-demand instance.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the on-demand instance.

Note You can call the DescribeOnDemandInstance operation to query the IDs of all on-demand instances.
ddosbgp-cn-z2q1qzxb****
RuleNamestringYes

The name of the scheduling rule.

The name can contain lowercase letters, digits, hyphens (-), and underscores (_). The name can be up to 32 characters in length. We recommend that you use the ID of the on-demand instance as the name. Example: ddosbgp-cn-z2q1qzxb****.

ddosbgp-cn-z2q1qzxb****
RuleConditionMbpsstringYes

The threshold of inbound bandwidth. Unit: Mbit/s. Minimum value: 100.

100
RuleConditionKppsstringYes

The threshold of inbound packets. Unit: Kpps. Minimum value: 10.

10
RuleConditionCntstringYes

If the inbound bandwidth or packets consecutively exceed the threshold for the specified number of times, the scheduling rule is triggered and traffic is rerouted to the on-demand instance. The specified number of times is the value of this parameter.

Note The threshold of inbound bandwidth is the value of RuleConditionMbps. The threshold of inbound packets is the value of RuleConditionKpps.
3
RuleActionstringYes

The scheduling action. Set the value to declare, which indicates that the route is advertised.

declare
RuleSwitchstringYes

Specifies whether the scheduling rule is enabled. Valid values:

  • on: enabled
  • off: disabled
on
RuleUndoModestringYes

The stop method of the scheduling rule. Valid values:

  • auto: The scheduling rule automatically stops.
  • manual: The scheduling rule is manually stopped.
manual
RuleUndoBeginTimestringYes

The start time of the period during which the scheduling rule is automatically stopped. The time must be in the 24-hour clock and in the hh:mm format.

If the system detects that DDoS attacks stop, the system no longer reroutes traffic to the on-demand instance from the time you specified. We recommend that you set this parameter to a value that is defined as off-peak hours.

Note This parameter takes effect only when the RuleUndoMode parameter is set to auto.
03:00
RuleUndoEndTimestringNo

The end time of the period during which the scheduling rule is automatically stopped. The time must be in the 24-hour clock and in the hh:mm format.

03:05
TimeZonestringYes

The time zone of the time when the scheduling rule automatically stops. The time zone must be in the GMT-hh:mm format.

For example, the value GMT-08:00 indicates that the time zone is UTC+8.

Note This parameter takes effect only when the RuleUndoMode parameter is set to auto.
GMT-08:00
RegionIdstringNo

The region ID of the on-demand instance.

Note You can call the DescribeRegions operation to query all regions supported by Anti-DDoS Origin.
cn-zhangjiakou

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.

BD06F539-2FBE-450D-9391-7EFF787128F5

Examples

Sample success responses

JSONformat

{
  "RequestId": "BD06F539-2FBE-450D-9391-7EFF787128F5"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history