全部产品
Search
文档中心

DDoS 防护:QuerySchedruleOnDemand - 查询代播实例的调度规则

更新时间:Mar 11, 2024

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
InstanceIdstring

要查询的代播实例的 ID。

说明 您可以调用 DescribeOnDemandInstance 查询所有代播实例的 ID。
ddosbgp-cn-z2q1qzxb****
RegionIdstring

代播实例的地域 ID。

说明 您可以调用 DescribeRegions 查询 DDoS 原生防护支持的所有地域信息。
cn-zhangjiakou

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

4A8F9980-5ACB-497F-9F15-48E9D6B29028
InstanceIdstring

代播实例的 ID。

ddosbgp-cn-z2q1qzxb****
UserIdstring

阿里云账号 ID。

171986973287****
RuleConfigobject []

调度规则的配置信息。

RuleSwitchstring

调度规则的开关状态。取值:

  • on:表示开启。
  • off:表示关闭。
on
RuleConditionMbpsstring

入方向带宽阈值,单位:Mbps。最小值:100

100
TimeZonestring

自动停止调度时间对应的时区。使用格林威治时间表示,格式:GMT-hh:mm

例如,GMT-08:00表示东八区。

说明 该参数仅在使用自动停止调度(RuleUndoMode 设置为 auto)时生效。
GMT-08:00
RuleActionstring

调度动作。取值固定为 declare,表示宣告路由。

declare
RuleConditionKppsstring

入方向报文数阈值,单位:Kpps。最小值:10

10
RuleUndoModestring

调度规则的停止方式。取值:

  • auto:表示自动停止调度。
  • manual:表示手动停止调度。
auto
RuleUndoBeginTimestring

自动停止调度的开始时间。使用 24 小时制表示,格式:hh:mm

当系统检测到攻击停止后,会在此处设置的时间开始停止代播防护。建议您将该时间设置为业务低峰期。

说明 该参数仅在使用自动停止调度(RuleUndoMode 设置为 auto)时生效。
03:00
RuleConditionCntstring

从互联网访问 IDC 的网络带宽或者报文数量连续超过阈值多少次时,将触发调度规则并开启代播防护。

说明 带宽阈值通过 RuleConditionMbps 参数设置,报文数阈值通过 RuleConditionKpps 参数设置。
3
RuleUndoEndTimestring

自动停止调度的结束时间。使用 24 小时制表示,格式:hh:mm

03:05
RuleNamestring

调度规则的名称。

ddosbgp-cn-z2q1qzxb****
RuleStatusobject []

调度规则的状态信息。

RuleSchedStatusstring

调度状态。取值:

  • scheduled:表示调度中。
  • unscheduled:表示不在调度中。
unscheduled
Netstring

代播网段。

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"
    }
  ]
}

错误码

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