文档首页/ 数据湖探索 DLI/ API参考/ 历史API/ 队列相关API(废弃)/ 创建队列定时扩缩容计划(废弃)
更新时间:2023-11-27 GMT+08:00
分享

创建队列定时扩缩容计划(废弃)

功能介绍

该API用于创建队列定时扩缩容计划,对指定的队列创建定时规格变更计划。

当前接口已废弃,不推荐使用。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式:

    POST /v1/{project_id}/queues/{queue_name}/plans

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    queue_name

    String

    需要设置定时扩缩计划的队列名称,名称只能包含数字、英文字母和下划线,但不能是纯数字,且不能以下划线开头。名称长度为1~128个字符。

请求消息

表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

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

请求示例

为队列创建名为plan_A的扩缩容计划,要求队列在星期一、星期二、星期三、星期日的20:30分开始扩缩容,目标CU为64CUs。

{
    "plan_name": "plan_A",
    "target_cu": 64,
    "start_hour": 20,
    "start_minute": 30,
    "repeat_day": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "SUNDAY"
    ],
    "valid_date_begin": 1590949800000,
    "valid_date_end": 1591727400000,
    "activate": true
}

响应示例

{
    "is_success": true,
    "message": ""
}

状态码

状态码如表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.

相关文档