1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
提交集成任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CommitIntegrationTask。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TaskId | 是 | String | 任务id 示例值："20220506145218687" |
| ProjectId | 是 | String | 项目id 示例值："11022568003970304" |
| CommitType | 否 | Integer | 0.仅提交，1.立即启动，2.停止线上作业，丢弃作业状态数据，重新启动运行，3.暂停线上作业，保留作业状态数据，继续运行，4.保留作业状态数据，继续运行 示例值：0 |
| TaskType | 否 | Integer | 实时任务 201 离线任务 202 默认实时任务 示例值：201 |
| ExtConfig.N | 否 | Array of RecordField | 额外参数 |
| VersionDesc | 否 | String | 提交版本描述 示例值："1" |
| InstanceVersion | 否 | Integer | 提交版本号 示例值：1 |
| EventDesc | 否 | String | 前端操作类型描述 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Boolean | 操作成功与否标识 示例值：true |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 1
2
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CommitIntegrationTask
<公共请求参数>
{
"TaskId": "kb947c997-4f91-4a1f-913d-06f66a5fb927",
"ProjectId": "1486804694126882816",
"CommitType": 1,
"TaskType": 201,
"VersionDesc": "v1",
"InstanceVersion": 3
}输出示例
{
"Response": {
"Error": {
"Code": "UnsupportedOperation",
"Message": "CloudApiException: The current task is locked by 100028625403 and cannot be committed"
},
"RequestId": "6a160ebb-720b-47a7-8f88-4e30f033955d"
}
}示例2 提交集成任务
提交集成任务
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CommitIntegrationTask
<公共请求参数>
{
"TaskId": "3cd6b1b3-76a0-4147-8f0e-6df206bc58c0",
"ProjectId": "1",
"CommitType": 0,
"TaskType": 1,
"ExtConfig": [
{
"Name": "name1",
"Value": "1"
}
]
}输出示例
{
"Response": {
"RequestId": "as1cs2c123asyi23bh213cc",
"Data": true
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.SignatureExpire | 未登录或登录已过期。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
