1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
批量终止实例
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：KillScheduleInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Instances.N | 否 | Array of InstanceOpsDto | 实例列表 示例值：[{"TaskId":"20240226154637701","CurRunDate":"2024-04-0900:00:00"},{"TaskId":"20240307215220701","CurRunDate":"2024-04-0900:00:00"}] |
| CheckFather | 否 | Boolean | 检查父任务类型, true: 检查父任务; false: 不检查父任务 |
| RerunType | 否 | String | 重跑类型, 1: 自身; 3: 孩子; 2: 自身以及孩子 |
| DependentWay | 否 | String | 实例依赖方式, 1: 自依赖; 2: 任务依赖; 3: 自依赖及父子依赖 |
| SkipEventListening | 否 | Boolean | 重跑忽略事件监听与否 |
| SonInstanceType | 否 | String | 下游实例范围 1: 所在工作流 2: 所在项目 3: 所有跨工作流依赖的项目 |
| SearchCondition | 否 | InstanceApiOpsRequest | 查询条件 |
| OptType | 否 | String | 访问类型 |
| OperatorName | 否 | String | 操作者名称 |
| OperatorId | 否 | String | 操作者id |
| ProjectId | 否 | String | 项目id 示例值："12634735943953945" |
| ProjectIdent | 否 | String | 项目标志 |
| ProjectName | 否 | String | 项目名称 |
| PageIndex | 否 | Integer | 索引页码 |
| PageSize | 否 | Integer | 页面大小 |
| Count | 否 | Integer | 数据总数 |
| RequestBaseInfo | 否 | ProjectBaseInfoOpsRequest | 基础请求信息 |
| IsCount | 否 | Boolean | 是否计算总数 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | BatchOperateResultOpsDto | 结果 示例值：{"ErrorDesc":null,"ErrorId":null,"Result":true} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量终止实例
实例运维-批量终止实例
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: KillScheduleInstances
<公共请求参数>
{
"ProjectId": "1460947878944567296",
"Instances": [
{
"TaskId": "20230313145539749",
"CurRunDate": "2023-03-13 14:55:53"
}
]
}输出示例
{
"Response": {
"Data": {
"ErrorDesc": null,
"ErrorId": null,
"Result": true
},
"RequestId": "7ac627e0-4ebf-4127-a3f0-a2d82c64f0e3"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |