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

重启/扩容/缩容队列

功能介绍

该API用于重新启动队列、扩容队列、缩容队列。

只有SQL类型的队列支持重启,且重启的时候队列的状态必须是可用状态(执行SQL作业成功后队列状态才是可用状态)。

调试

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

URI

  • URI格式:

    PUT /v1.0/{project_id}/queues/{queue_name}/action

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    queue_name

    String

    队列名称。

请求消息

表2 请求参数

参数名称

是否必选

参数类型

说明

action

String

执行动作:

  • restart:重启
  • scale_out:扩容
  • scale_in:缩容
说明:

目前只支持restart、scale_out、scale_in。

force

Boolean

是否强制重启,“action”“restart”时可选择配置,默认为“false”

cu_count

Integer

扩容或者缩容的cu数。“action”“scale_out”或者“scale_in”时可选择配置。“cu_count”必须是16的倍数。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

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

message

String

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

job_id

String

“force”“true”时返回的job_id。

queue_name

String

扩缩容的队列名称。

result

Boolean

扩缩容结果。

示例

  • 请求样例:
    • 重启:
      {
          "action": "restart",
          "force": "false"
      }
    • 扩容:
      {
          "action": "scale_out",
          "cu_count": 16
      }
  • 成功响应样例:
    • “force”“false”
      {
          "is_success": true,
          "message": "Restart success"
      }
    • “force”“true”
      {
          "is_success": true,
          "message": "Submit restart job success, it need some time to cancel jobs, please wait for a while and check job status",
          "job_id": "d90396c7-3a25-4944-ad1e-99c764d902e7"
      }
    • 扩缩容
      {
          "queue_name": "myQueue",
          "result": true
      }

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

操作成功。

400

请求错误。

500

内部服务器错误。

错误码

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

表5 错误码

错误码

错误信息

DLI.0015

Token info for token is null, return.

DLI.0013

X-Auth-Token is not defined in request. It is mandatory. Please define and send the request.

分享:

    相关文档

    相关产品

close