文档首页> 数据湖探索 DLI> API参考（阿布扎比区域）> 队列相关API（推荐）> 修改队列定时扩缩容计划
更新时间：2022-12-07 GMT+08:00
查看PDF

修改队列定时扩缩容计划

功能介绍

该API用于修改指定ID的队列的定时扩缩容计划。

URI

  • URI格式：

    PUT /v1/{project_id}/queues/{queue_name}/plans/{plan_id}

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

    项目编号，用于资源隔离。获取方式请参考获取项目ID。

    queue_name

    是

    String

    待修改定时扩缩计划的队列名称。名称长度为1~128个字符，多个队列名称使用逗号“,”分隔。

    plan_id

    是

    String

    待修改的队列扩缩容计划的ID。多个ID使用逗号“,”分隔。具体获取请参考查看队列定时扩缩容计划

请求消息

表2 请求参数

参数名称

是否必选

参数类型

说明

plan_name

是

String

队列扩缩容计划名称，名称只能包含数字、英文字母和下划线，但不能是纯数字，且不能以下划线开头。

target_cu

是

Integer

队列扩缩容计划CU的目标值。

start_hour

是

Integer

队列扩缩容计划起始小时时间。

start_minute

是

Integer

队列扩缩容计划的起始分钟时间。

repeat_day

是

Array of strings

定时扩缩容计划的重复周期，可以选择周一到周日的某一天、某几天、或者不选择。如果不选择，则会在当前时间后的start_hour：start_minute时间点执行扩缩容计划。例如：

"repeat_day": ["MONDAY", "TUESDAY", "WEDNESDAY","SUNDAY"]

valid_date_begin

否

Long

有效期开始时间（13位时间戳）。

valid_date_end

否

Long

有效期结束时间（13位时间戳）。

activate

否

Boolean

当前设置的扩缩容计划是否激活，默认为“true”，表示激活。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

否

Boolean

请求执行是否成功。“true”表示请求执行成功。

message

否

String

系统提示信息，执行成功时，信息可能为空。

queue_name

否

String

待修改定时扩缩计划的队列名称。名称长度为1~128个字符，多个队列名称使用逗号“,”分隔。

plan_id

否

String

待修改的队列扩缩容计划的ID。多个ID使用逗号“,”分隔。

请求示例

{
    "plan_name": "plan_Ad",
    "target_cu": 64,
    "start_hour": 19,
    "start_minute": 30,
    "repeat_day": ["THURSDAY","friday"],
    "activate": false
}

响应示例

{
    "is_success": true,
    "message": "",
    "queue_name": "queue1",
    "plan_id": 3
}

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

修改成功。

400

请求失败。

500

内部服务器错误。

错误码

调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见错误码。

表5 错误码

错误码

错误信息

DLI.0999

Queue plans create failed. The plan plan_A can not generate a scale plan, please check all time

settings for the plan.