文档

SwitchSchedulerRule - 切换调度规则

更新时间:

将业务流量切换到DDoS高防实例进行清洗、回切到联动资源。

接口说明

本接口用于修改单个流量调度规则的当前生效资源,例如,将业务流量切换到 DDoS 高防实例进行清洗、回切到联动资源。

调用本接口前,您必须已经调用 CreateSchedulerRule 创建了流量调度规则。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

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

授权信息

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

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

请求参数

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

要操作的流量调度规则的名称。

说明 您可以调用 DescribeSchedulerRules 查询所有流量调度规则的名称。
testrule
RuleTypeinteger

流量调度规则的类型。取值:

  • 2:表示阶梯防护规则。
  • 3:表示出海加速规则。
  • 5:表示 CDN 联动规则。
  • 6:表示云产品联动规则。
6
SwitchDatastring

业务流量切换操作的配置。使用 JSON 数组转化的字符串表示,JSON 数组的每个元素是一个结构体,结构体包含以下字段:

  • Value:String 类型 | 必选 | 联动资源的 IP 地址。

  • State:Integer 类型 | 必选 | 操作类型。取值:

    • 0:表示将业务流量从联动资源切换到 DDoS 高防实例进行清洗。
    • 1:表示将业务流量回切到联动资源。
  • Interval:Integer 类型 | 可选 | 回切时间,单位:分钟。使用说明:

    • State0(表示切换到高防时),必须设置该参数为**-1**,否则会调用失败。
    • State1(表示回切到云资源时,无需设置该参数。
[{"Value":"39.104.XX.XX","State":0,"Interval":-1}]

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

7E3C301F-84BB-50E4-9DB9-2937B2429C1E

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史