1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
查询集成任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeIntegrationTask。 |
| Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TaskId | 是 | String | 任务id 示例值:5c6f6968-97c0-4e40-b25b-8258c0170f4 |
| ProjectId | 是 | String | 项目id 示例值:1486446569620893696 |
| TaskType | 否 | Integer | 任务类型,201: 实时集成任务, 202:离线集成任务,不传默认值为201 实时任务类型 示例值:201 |
| InstanceVersion | 否 | Integer | 提交版本号 示例值:12 |
| ExtConfig.N | 否 | Array of RecordField | 额外参数 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskInfo | IntegrationTaskInfo | 任务信息 注意:此字段可能返回 null,表示取不到有效值。 |
| AgentStatus | AgentStatus | 采集器统计信息 注意:此字段可能返回 null,表示取不到有效值。 |
| TaskVersion | TaskVersionInstance | 任务版本信息 注意:此字段可能返回 null,表示取不到有效值。 |
| TaskVersionList | Array of RealtimeTaskInstanceVO | 历史实例信息 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集成任务
查询集成任务
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntegrationTask
<公共请求参数>
{
"TaskId": "r8f71567c-90eb-4452-98ee-432b7d516053",
"ProjectId": "2804706451775033344"
}
输出示例
{
"Response": {
"AgentStatus": null,
"TaskInfo": {
"AppId": "1300298608",
"ArrangeSpaceTaskId": null,
"BusinessLatency": null,
"Config": [
{
"Name": "TableType",
"Value": "in"
}
],
"CreateTime": "2026-07-27 16:18:27",
"CreatorUin": "700001601851",
"CurrentSyncPosition": null,
"DataProxyUrl": null,
"Description": "",
"ErrorMessage": null,
"ExecuteContext": [],
"ExecutorGroupName": null,
"ExecutorId": "20260604232305097989",
"ExtConfig": null,
"HasVersion": true,
"InLongManagerUrl": null,
"InLongManagerVersion": null,
"InLongStreamId": "",
"Incharge": "700001815122",
"InputDatasourceType": "MYSQL",
"InstanceVersion": 3,
"LastOperateInfo": {
"CreatedTime": "2026-08-17 19:27:54",
"ErrorMsg": null,
"OperateId": "df73c92c-052c-4024-b7d6-dfe2a7095f1a",
"TaskEvent": "STOP",
"UpdatedTime": "2026-08-17 19:28:09"
},
"LastRunTime": null,
"Locked": true,
"Locker": "700001601851",
"Mappings": null,
"Nodes": [
{
"AppId": "1300298608",
"Config": [
{
"Name": "StartupMode",
"Value": "INIT"
}
],
"CreateTime": null,
"CreatorUin": null,
"DataSourceType": "MYSQL",
"DatasourceId": "65614",
"Description": null,
"ExtConfig": null,
"Id": "1",
"Name": "mysql_menghuiyu",
"NodeMapping": null,
"NodeType": "INPUT",
"OperatorUin": null,
"OwnerUin": "700001601851",
"ProjectId": "2804706451775033344",
"Schema": null,
"TaskId": "r8f71567c-90eb-4452-98ee-432b7d516053",
"UpdateTime": null
}
],
"NotExistsCheckPoint": null,
"NumRecordsIn": -1,
"NumRecordsOut": -1,
"NumRestarts": -1,
"OfflineTaskAddEntity": null,
"OfflineTaskStatus": 1,
"OperatorUin": "700001601851",
"OutputDatasourceType": "DLC",
"OwnerUin": "700001601851",
"ProjectId": "2804706451775033344",
"ReadPhase": null,
"ReaderDelay": -1,
"RunningCu": 0,
"SavePointId": null,
"SavePointPath": null,
"ScheduleTaskId": "",
"Status": 6,
"StopTime": null,
"Submit": null,
"SwitchResource": null,
"SyncType": 1,
"TagList": null,
"TaskAlarmRegularList": null,
"TaskGroupId": "-1",
"TaskId": "r8f71567c-90eb-4452-98ee-432b7d516053",
"TaskImportInfo": null,
"TaskMode": "",
"TaskName": "test_cheneiwang2",
"TaskType": 201,
"UpdateTime": "2026-08-17 19:28:10",
"WorkflowId": "-1"
},
"TaskVersion": null,
"TaskVersionList": [
{
"InstanceDate": "2026-08-13 17:11:35",
"RunningOrderId": 1
}
],
"RequestId": "6cbbf4d0-1b01-410d-8860-84c5d3c1be7b"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.SignatureExpire | 未登录或登录已过期。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |