终止任务实例

最近更新时间:2018-11-08 20:28:45

1. 接口描述

接口请求域名: batch.tencentcloudapi.com 。

用于终止任务实例 对于状态已经为SUCCEED、FAILED的TaskInstance,batch不做处理。 对于状态为SUBMITTED、PENDING、RUNNABLE的TaskInstance,batch会将其置为FAILED状态。 对于状态为STARTING、RUNNING、FAILED_INTERRUPTED的TaskInstance,batch会先终止CVM,然后将状态置为FAILED,因此具有一定耗时。特别是如果CVM正在创建中,此时无法立即销毁CVM,Batch会在旁路注册一个定时销毁操作,在CVM创建好之后异步销毁。 对于状态为FAILED_INTERRUPTED的TaskInstance,TerminateTaskInstance操作实际成功之后,相关资源和配额才会释放。 本接口只支持提交到匿名计算环境的作业(SubmitJob指定ComputeEnv,不指定EnvId)。对于提交到具名计算环境的作业(SubmitJob指定EnvId,不指定ComputeEnv),不支持TerminateTaskInstance和TerminateJob操作。

默认接口请求频率限制:2次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:TerminateTaskInstance
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
JobId String 作业ID
TaskName String 任务名称
TaskInstanceIndex Integer 任务实例索引

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 终止任务实例

输入示例

https://batch.tencentcloudapi.com/?Action=TerminateTaskInstance
&JobId=job-rybewp57
&TaskName=A
&TaskInstanceIndex=0
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "72e9a712-1fed-4b57-be72-62e71eefd4c3"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalError 内部错误
InvalidParameter.JobIdMalformed 非法的作业ID格式。
ResourceNotFound.TaskInstance 指定任务实例不存在。
UnsupportedOperation.TerminateOperationWithEnvId 指定计算环境的任务实例禁止该操作。