更新时间：2026-04-21 GMT+08:00
取消任务 - CancelJobs
功能介绍
取消任务，当前只支持扩缩集群的任务取消。
URI
POST /v1/jobs/cancel
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
job_ids |
是 |
Array of strings |
参数解释 需要取消的任务ID列表。 约束限制 不涉及。 取值范围 任务ID列表，每个任务ID必须为以"short-"或"long-"开头，后跟字母、数字、连字符和下划线组成的字符串。 默认取值 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
success_rows |
Integer |
参数解释 取消成功的任务数量。 取值范围 值为大于等于0的整数。 |
|
failed_rows |
Integer |
参数解释 取消失败的任务数量。 取值范围 值为大于等于0的整数。 |
|
failed_ids |
Array of strings |
参数解释 取消失败的任务ID列表，包含无法取消的任务标识符。 取值范围 任务ID数组，每个任务ID必须为以"short-"或"long-"开头，后跟字母、数字、连字符和下划线组成的字符串，最多100个元素。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 错误码，用于标识具体的错误类型。 取值范围 不涉及。 |
|
error_msg |
String |
参数解释 错误描述，用于说明具体的错误信息。 取值范围 不涉及。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 错误码，用于标识具体的错误类型。 取值范围 不涉及。 |
|
error_msg |
String |
参数解释 错误描述，用于说明具体的错误信息。 取值范围 不涉及。 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
参数解释 取消任务成功返回响应体。 取值范围 不涉及。 |
|
400 |
参数解释 错误响应体。 取值范围 不涉及。 |
|
403 |
参数解释 错误响应体。 取值范围 不涉及。 |
错误码
请参见错误码章节。
父主题： 任务管理
