1. 接口描述
接口请求域名： batch.tencentcloudapi.com 。
用于终止作业。 当作业处于“SUBMITTED”状态时，禁止终止操作；当作业处于“SUCCEED”状态时，终止操作不会生效。 终止作业是一个异步过程。整个终止过程的耗时和任务总数成正比。终止的效果相当于所含的所有任务实例进行TerminateTaskInstance操作。具体效果和用法可参考TerminateTaskInstance。
默认接口请求频率限制：2次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：TerminateJob |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| JobId | 是 | String | 作业ID |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 终止作业
输入示例
https://batch.tencentcloudapi.com/?Action=TerminateJob
&JobId=job-rybewp57
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "970e5a9f-2963-436c-8dad-4847360676f7"
}
}5. 开发者资源
API Explorer
该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力，能显著降低使用云 API 的难度，推荐使用。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误 |
| InvalidParameter.JobIdMalformed | 非法的作业ID格式。 |
| ResourceNotFound.Job | 指定作业不存在。 |
| UnsupportedOperation.TerminateOperationWithEnvId | 指定计算环境的任务实例禁止该操作。 |