
# 重启/扩容/缩容队列 - RunQueueAction
#### 功能介绍
该API用于重新启动队列、扩容队列、缩容队列。
![](https://support.huaweicloud.com/api-dli/public_sys-resources/note_3.0-zh-cn.png)
- 只有SQL类型的队列支持重启，且重启的时候队列的状态必须是可用状态（执行SQL作业成功后队列状态才是可用状态）。
- 该接口不支持对弹性资源池队列扩容和缩容。如需对弹性资源池接口扩缩容请参考[修改弹性资源池关联队列的扩缩容策略 - UpdateElasticResourcePoolQueue](https://support.huaweicloud.com/api-dli/dli_02_0332.html)。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DLI&api=RunQueueAction)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限及授权项说明](https://support.huaweicloud.com/api-dli/dli_02_0375.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | 条件键 Condition Key                                                                                                                                                                                                                                                                                                                 | 别名 Alias               | 依赖的授权项 Dependencies |
  |:---|:---|:---|:---|:---|:---|
  | dli:queue:scale                         | Write                                           | queue \*                                                               | -                                                                                                                                                                                                                                                                                                                                                              | dli:queue:scaleQueue - | -                                                 |
  | dli:queue:scale                         | Write                                           | -                                                                      | - [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html)  - [g:ResourceTag/\<tag-key\>](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html)   | dli:queue:scaleQueue - | -                                                 |
     
  
 
#### URI
- URI格式： PUT /v1.0/{project_id}/queues/{queue_name}/action
  
- 参数说明
  表1URI参数 
  | 参数名称       | 是否必选 | 参数类型   | 说明                                                                                     |
  |:---|:---|:---|:---|
  | project_id | 是    | String | 项目编号，用于资源隔离。获取方式请参考[获取项目ID](https://support.huaweicloud.com/api-dli/dli_02_0183.html)。 |
  | queue_name | 是    | String | 队列名称。                                                                                  |
     
  
 
#### 请求消息
表2请求参数 
| 参数名称     | 是否必选 | 参数类型    | 说明                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| action   | 是    | String  | 执行动作： - restart：重启。只有SQL类型的队列支持重启。  - 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
  }
  ```
  
- 将队列的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]所示。
 表4状态码 
| 状态码 | 描述       |
|:---|:---|
| 200 | 操作成功。    |
| 400 | 请求错误。    |
| 500 | 内部服务器错误。 |
   
#### 错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见[错误码](https://support.huaweicloud.com/api-dli/dli_02_0056.html)。
表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. |
   
