# 重启SparkSql集群 - RestartSparkSqlCluster
#### 功能介绍
重启SparkSql集群，该接口为异步接口，接口调用成功后会返回操作ID（operation_id），您可以通过查询Spark异步操作状态接口查询操作执行结果，详情请参见[查询Spark异步操作状态](https://support.huaweicloud.com/api-aidatalake/ShowSparkOperatorState.html)。
#### 接口约束
- 重启集群会导致正在运行的作业被终止，请提前做好数据保存。
  
- 不同的restart_strategy对应不同的重启行为，请谨慎选择。
  
 
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-aidatalake/aidatalake_02_0003.html)。
#### URI
POST /v2/workspaces/{workspace_id}/endpoints/{endpoint_name}/spark-sqls/restart-cluster
表1路径参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                       |
|:---|:---|:---|:---|
| workspace_id  | 是    | String | **参数解释**：工作空间ID，用于资源隔离。可在控制台的工作空间页面查看。 **约束限制**：不涉及。 **取值范围**：只能由英文字母、数字及中划线组成，且长度为32\~36个字符。 **默认取值**：不涉及。                |
| endpoint_name | 是    | String | **参数解释**：端点名称，用于标识SparkSql集群的接入点。 **约束限制**：不涉及。 **取值范围**：只能由小写字母、数字及中划线组成，必须以小写字母开头，以小写字母或数字结尾，且长度为1\~63个字符。 **默认取值**：不涉及。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释**：用户Token。 **约束限制**：不涉及。 **取值范围**：长度不超过65534个字符。 **默认取值**：不涉及。 |
   
表3请求Body参数 
| 参数               | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| restart_strategy | 是    | String | **参数解释**：集群重启策略，用于指定重启方式。 **约束限制**：不涉及。 **取值范围**： - FORCE：强制重启，不等待正在运行的作业完成。   - GRACEFUL：优雅重启，等待所有正在运行的作业完成后再重启。    **默认取值**：不涉及。 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数           | 参数类型   | 描述                                                                                                            |
|:---|:---|:---|
| operation_id | String | **参数解释**：重启操作ID，用于标识本次重启操作。 **取值范围**：只能由英文字母、数字及中划线组成，且长度为1\~64个字符。 |
   
**状态码：400**
表5响应Body参数 
| 参数           | 参数类型   | 描述                                                                                         |
|:---|:---|:---|
| error_code   | String | **参数解释**：错误码，用于标识具体的错误类型。 **取值范围**：长度为0\~64个字符。  |
| error_msg    | String | **参数解释**：错误描述信息，用于说明错误原因。 **取值范围**：长度为0\~512个字符。 |
| solution_msg | String | **参数解释**：解决方案描述。 **取值范围**：长度为0\~4096个字符。         |
   
**状态码：401**
表6响应Body参数 
| 参数           | 参数类型   | 描述                                                                                         |
|:---|:---|:---|
| error_code   | String | **参数解释**：错误码，用于标识具体的错误类型。 **取值范围**：长度为0\~64个字符。  |
| error_msg    | String | **参数解释**：错误描述信息，用于说明错误原因。 **取值范围**：长度为0\~512个字符。 |
| solution_msg | String | **参数解释**：解决方案描述。 **取值范围**：长度为0\~4096个字符。         |
   
**状态码：403**
表7响应Body参数 
| 参数           | 参数类型   | 描述                                                                                         |
|:---|:---|:---|
| error_code   | String | **参数解释**：错误码，用于标识具体的错误类型。 **取值范围**：长度为0\~64个字符。  |
| error_msg    | String | **参数解释**：错误描述信息，用于说明错误原因。 **取值范围**：长度为0\~512个字符。 |
| solution_msg | String | **参数解释**：解决方案描述。 **取值范围**：长度为0\~4096个字符。         |
   
**状态码：500**
表8响应Body参数 
| 参数 | 参数类型   | 描述    |
|:---|:---|:---|
| -  | String | 错误信息。 |
   
#### 请求示例
重启SparkSql集群。
```
POST /v2/workspaces/{workspace_id}/endpoints/{endpoint_name}/spark-sqls/restart-cluster
{
  "restart_strategy" : "GRACEFUL"
}
```
#### 响应示例
**状态码：200**
异步下发重启集群成功。
```
{
  "operation_id" : "019ed01e-b10e-71da-bd83-523d97796ec2"
}
```
**状态码：400**
请求参数错误。
```
{
  "error_code" : "AIDataLake.01011001",
  "error_msg" : "Invalid parameter restart_strategy",
  "solution_msg" : "Please check the input parameters according to the documentation(restart_strategy for restart cluster)."
}
```
**状态码：401**
认证失败。
```
{
  "error_code" : "AIDataLake.01011003",
  "error_msg" : "auth token not exists in header",
  "solution_msg" : "Please check if auth token is included in the request header."
}
```
**状态码：403**
权限不足。
```
{
  "error_code" : "AIDataLake.01011005",
  "error_msg" : "current account has no permission",
  "solution_msg" : "Please connect administrators to add permission."
}
```
#### 状态码
| 状态码 | 描述          |
|:---|:---|
| 200 | 异步下发重启集群成功。 |
| 400 | 请求参数错误。     |
| 401 | 认证失败。       |
| 403 | 权限不足。       |
| 500 | 服务内部错误。     |