1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
删除编排空间任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DeleteTaskDs。 |
Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProjectId | 是 | String | 项目Id 示例值:1485413911111111111 |
DeleteScript | 否 | Boolean | 是否删除脚本 true:删除 false:不删除 不传默认false 示例值:FALSE |
OperateInform | 否 | Boolean | 任务操作是否消息通知下游任务责任人true:通知 false:不通知 不传默认false 示例值:FALSE |
TaskId | 否 | String | 任务ID 和VirtualTaskId选填一个 示例值:202305231111111111 |
VirtualTaskId | 否 | String | 虚拟任务id 和TaskId选填一个 示例值:20230523111111111 |
VirtualFlag | 否 | Boolean | 虚拟任务标记 true:是虚拟任务 false:不是虚拟任务 不传默认false 示例值:FALSE |
DeleteMode | 否 | Boolean | 任务删除方式 true:不针对下游任务实例进行强制失败 false:针对下游任务实例进行强制失败 不传默认false 示例值:FALSE |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Boolean | 是否删除成功 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 任务删除
任务删除
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteTaskDs
<公共请求参数>
{
"ProjectId": "1470547050521227264",
"DeleteScript": true,
"OperateInform": true,
"TaskId": "20230523111838986",
"VirtualTaskId": "20230523111838986",
"VirtualFlag": true,
"DeleteMode": true
}
输出示例
{
"Response": {
"Data": true,
"RequestId": "77b63b69-b3c5-48ea-809e-d1bbfc1b3da0"
}
}
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 | 操作失败。 |