重启/扩容/缩容队列

功能介绍

该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	队列名称。

请求消息

响应消息

请求示例

• 重启队列。

  {
      "action": "restart",
      "force": "false"
  }

• 将队列的CU扩容16CU。

  {
      "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所示。

错误码

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