更新时间:2022-04-16 GMT+08:00
分享

查看队列定时扩缩容计划

功能介绍

该API用于查看队列定时扩缩容计划,列出指定队列定时规格变更计划。

调试

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

URI

  • URI格式:

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

  • 参数说明
    表1 URI参数

    名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    queue_name

    String

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

请求消息

无请求参数。

响应消息

表2 响应参数

参数

是否必选

参数类型

说明

is_success

Boolean

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

message

String

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

plans

Array of Objects

定时扩缩容计划信息。具体请参考表3

表3 plans参数

参数名称

是否必选

参数类型

说明

id

Long

扩缩容计划的ID编号。

plan_name

String

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

target_cu

Integer

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

start_hour

Integer

队列扩缩容计划起始小时时间(24小时制)。

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”,表示激活。

last_execute_time

Long

当前扩缩容计划最近一次执行的时间。

示例

  • 请求样例:
    None
  • 成功响应样例:
    {
        "is_success": true,
        "message": "",
        "plans": [
            {
                "id": 1,
                "plan_name": "plan_Aa",
                "target_cu": 32,
                "start_hour": 11,
                "start_minute": 15,
                "repeat_day": [
                    "MONDAY",
                    "TUESDAY",
                    "WEDNESDAY",
                    "SUNDAY"
                ],
                "activate": true,
                "last_execute_time": 1593573428857
            },
            {
                "id": 6,
                "plan_name": "plan_Ab",
                "target_cu": 16,
                "start_hour": 14,
                "start_minute": 25,
                "repeat_day": [
                    "MONDAY",
                    "TUESDAY",
                    "WEDNESDAY",
                    "SUNDAY",
                    "THURSDAY",
                    "FRIDAY",
                    "SATURDAY"
                ],
                "activate": true,
                "last_execute_time": 1593584829260
            }
        ]
    }

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

查询成功。

400

请求失败。

500

内部服务器错误。

错误码

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

表5 错误码

错误码

错误信息

DLI.0008

There is no queue named queue1.

分享:

    相关文档

    相关产品

close