重启/扩容/缩容队列
功能介绍
该API用于重新启动队列、扩容队列、缩容队列。
只有SQL类型的队列支持重启,且重启的时候队列的状态必须是可用状态(执行SQL作业成功后队列状态才是可用状态)。
URI
- URI格式:
- 参数说明
表1 URI参数 参数名称
是否必选
参数类型
说明
project_id
是
String
项目编号,用于资源隔离。获取方式请参考获取项目ID。
queue_name
是
String
队列名称。
请求消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
action |
是 |
String |
执行动作:
说明:
目前只支持restart、scale_out、scale_in。 |
force |
否 |
Boolean |
是否强制重启,“action”为“restart”时可选择配置,默认为“false”。 |
cu_count |
否 |
Integer |
扩容或者缩容的cu数。“action”为“scale_out”或者“scale_in”时可选择配置。“cu_count”必须是16的倍数。 |
响应消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
is_success |
否 |
Boolean |
请求执行是否成功。“true”表示请求执行成功。 |
message |
否 |
String |
系统提示信息,执行成功时,信息可能为空。 |
job_id |
否 |
String |
当“force”为“true”时返回的job_id。 |
queue_name |
否 |
String |
扩缩容的队列名称。 |
result |
否 |
Boolean |
扩缩容结果。 |
请求示例
- 重启队列。
{ "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 }
错误码
调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码。
错误码 |
错误信息 |
---|---|
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. |