调用QuerySchedruleOnDemand查询代播实例的调度规则_DDoS防护(Anti-DDoS)-阿里云帮助中心

查询代播实例的调度规则。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-antiddosbag:QuerySchedruleOnDemand	get	全部资源 *	无	无

请求参数

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

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

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

返回参数

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

示例

正常返回示例

JSON格式

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

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史