QuerySchedruleOnDemand - DDoS防护

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	QuerySchedruleOnDemand	要执行的操作。取值：QuerySchedruleOnDemand。
InstanceId	String	是	ddosbgp-cn-z2q1qzxb****	要查询的代播实例的ID。说明您可以调用DescribeOnDemandInstance查询所有代播实例的ID。
RegionId	String	否	cn-zhangjiakou	代播实例的地域ID。说明您可以调用DescribeRegions查询DDoS原生防护支持的所有地域信息。

调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用API的请求格式，请参见本文示例中的请求示例。

返回数据


名称	类型	示例值	描述
InstanceId	String	ddosbgp-cn-z2q1qzxb****	代播实例的ID。
RequestId	String	4A8F9980-5ACB-497F-9F15-48E9D6B29028	本次请求的ID。
RuleConfig	Array of Config		调度规则的配置信息。
RuleAction	String	declare	调度动作。取值固定为declare，表示宣告路由。
RuleConditionCnt	String	3	从互联网访问IDC的网络带宽或者报文数量连续超过阈值多少次时，将触发调度规则并开启代播防护。说明带宽阈值通过RuleConditionMbps参数设置，报文数阈值通过RuleConditionKpps参数设置。
RuleConditionKpps	String	10	入方向报文数阈值，单位：Kpps。最小值：10。
RuleConditionMbps	String	100	入方向带宽阈值，单位：Mbps。最小值：100。
RuleName	String	ddosbgp-cn-z2q1qzxb****	调度规则的名称。
RuleSwitch	String	on	调度规则的开关状态。取值： on：表示开启。 off：表示关闭。
RuleUndoBeginTime	String	03:00	自动停止调度的开始时间。使用24小时制表示，格式：`hh:mm`。当系统检测到攻击停止后，会在此处设置的时间开始停止代播防护。建议您将该时间设置为业务低峰期。说明该参数仅在使用自动停止调度（RuleUndoMode设置为auto）时生效。
RuleUndoEndTime	String	03:05	自动停止调度的结束时间。使用24小时制表示，格式：`hh:mm`。
RuleUndoMode	String	auto	调度规则的停止方式。取值： auto：表示自动停止调度。 manual：表示手动停止调度。
TimeZone	String	GMT-08:00	自动停止调度时间对应的时区。使用格林威治时间表示，格式：`GMT-hh:mm`。例如，`GMT-08:00`表示东八区。说明该参数仅在使用自动停止调度（RuleUndoMode设置为auto）时生效。
RuleStatus	Array of Status		调度规则的状态信息。
Net	String	47.*.*.0/24	代播网段。
RuleSchedStatus	String	unscheduled	调度状态。取值： scheduled：表示调度中。 unscheduled：表示不在调度中。
UserId	String	171986973287****	阿里云账号ID。

示例

请求示例

http(s)://[Endpoint]/?Action=QuerySchedruleOnDemand
&InstanceId=ddosbgp-cn-z2q1qzxb****
&<公共请求参数>

正常返回示例

XML 格式

<QuerySchedruleOnDemandResponse>
	  <RequestId>4A8F9980-5ACB-497F-9F15-48E9D6B29028</RequestId>
	  <InstanceId>ddosbgp-cn-z2q1qzxb****</InstanceId>
	  <UserId>171986973287****</UserId>
	  <RuleStatus>
		    <RuleSchedStatus>unscheduled</RuleSchedStatus>
		    <Net>47.***.***.0/24</Net>
	  </RuleStatus>
	  <RuleConfig>
		    <RuleUndoEndTime>03:05</RuleUndoEndTime>
		    <RuleSwitch>on</RuleSwitch>
		    <TimeZone>GMT-08:00</TimeZone>
		    <RuleConditionCnt>3</RuleConditionCnt>
		    <RuleAction>declare</RuleAction>
		    <RuleConditionMbps>100</RuleConditionMbps>
		    <RuleConditionKpps>10</RuleConditionKpps>
		    <RuleUndoMode>auto</RuleUndoMode>
		    <RuleName>ddosbgp-cn-z2q1qzxb****</RuleName>
		    <RuleUndoBeginTime>03:00</RuleUndoBeginTime>
	  </RuleConfig>
</QuerySchedruleOnDemandResponse>

JSON 格式

{
	"RequestId": "4A8F9980-5ACB-497F-9F15-48E9D6B29028",
	"InstanceId": "ddosbgp-cn-z2q1qzxb****",
	"UserId": "171986973287****",
	"RuleStatus": [
		{
			"RuleSchedStatus": "unscheduled",
			"Net": "47.***.***.0/24"
		}
	],
	"RuleConfig": [
		{
			"RuleUndoEndTime": "03:05",
			"RuleSwitch": "on",
			"TimeZone": "GMT-08:00",
			"RuleConditionCnt": "3",
			"RuleAction": "declare",
			"RuleConditionMbps": "100",
			"RuleConditionKpps": "10",
			"RuleUndoMode": "auto",
			"RuleName": "ddosbgp-cn-z2q1qzxb****",
			"RuleUndoBeginTime": "03:00"
		}
	]
}

错误码

访问错误中心查看更多错误码。