取消Spark作业执行 - CancelSparkJob
功能介绍
取消正在运行或排队中的Spark作业，此接口为同步接口。只能取消处于QUEUED或RUNNING状态的作业，调用成功后直接返回取消结果。
调用方法
请参见如何调用API。
URI
POST /v2/workspaces/{workspace_id}/spark-jobs/{job_id}/cancel
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 是 | String | 参数解释：工作空间ID，用于资源隔离。可在控制台的工作空间页面查看。 约束限制：不涉及。 取值范围：只能由英文字母、数字及中划线组成，且长度为32~36个字符。 默认取值：不涉及。 |
| job_id | 是 | String | 参数解释：Spark作业ID，用于唯一标识作业。可通过调用启动Spark作业接口获取返回值中的job_id，或通过查询Spark作业列表接口获取。 约束限制：不涉及。 取值范围：只能由十六进制字符、中划线及下划线组成，长度为1~64个字符。 默认取值：不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释：用户Token，通过调用获取IAM用户Token接口获取。 约束限制：不涉及。 取值范围：长度不超过65534个字符，不涉及字符类型限制。 默认取值：不涉及。 |
响应参数
状态码：204
无
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释：错误码，用于标识具体的错误类型。 取值范围：长度为0~64个字符。 |
| error_msg | String | 参数解释：错误描述信息，用于说明错误原因。 取值范围：长度为0~512个字符。 |
| solution_msg | String | 参数解释：解决方案描述。 取值范围：长度为0~4096个字符。 |
状态码：401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释：错误码，用于标识具体的错误类型。 取值范围：长度为0~64个字符。 |
| error_msg | String | 参数解释：错误描述信息，用于说明错误原因。 取值范围：长度为0~512个字符。 |
| solution_msg | String | 参数解释：解决方案描述。 取值范围：长度为0~4096个字符。 |
状态码：403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释：错误码，用于标识具体的错误类型。 取值范围：长度为0~64个字符。 |
| error_msg | String | 参数解释：错误描述信息，用于说明错误原因。 取值范围：长度为0~512个字符。 |
| solution_msg | String | 参数解释：解决方案描述。 取值范围：长度为0~4096个字符。 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释：错误码，用于标识具体的错误类型。 取值范围：长度为0~64个字符。 |
| error_msg | String | 参数解释：错误描述信息，用于说明错误原因。 取值范围：长度为0~512个字符。 |
| solution_msg | String | 参数解释：解决方案描述。 取值范围：长度为0~4096个字符。 |
请求示例
取消指定的Spark作业，示例中通过job_id定位该作业。
POST /v2/workspaces/{workspace_id}/spark-jobs/{job_id}/cancel 响应示例
状态码：204
无
状态码：400
{
"error_code" : "AIDataLake.01011001",
"error_msg" : "Invalid parameter job_id",
"solution_msg" : "Please check the input parameters according to the documentation(job_id for spark job)."
} 状态码：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."
} 状态码：500
{
"error_code" : "AIDataLake.01010001",
"error_msg" : "Internal system error",
"solution_msg" : "Contact operations for analysis."
} 状态码
| 状态码 | 描述 |
|---|---|
| 204 | 取消作业成功，无响应参数。 |
| 400 | 请求参数错误。 |
| 401 | 认证失败。 |
| 403 | 权限不足。 |
| 500 | 服务内部错误。 |
