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 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskInfo | IntegrationTaskInfo | 任务信息 注意：此字段可能返回 null，表示取不到有效值。 |
| AgentStatus | AgentStatus | 采集器统计信息 注意：此字段可能返回 null，表示取不到有效值。 |
| TaskVersion | TaskVersionInstance | 任务版本信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集成任务
查询集成任务
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntegrationTask
<公共请求参数>
{
"TaskId": "c6f6968-97c0-4e40-b25b-8258c0170f4",
"ProjectId": "1486446569620893696",
"TaskType": 201,
"InstanceVersion": 12
}输出示例
{
"Response": {
"TaskInfo": {
"TaskName": "testtaskname",
"Description": "testdesc",
"SyncType": 2,
"TaskType": 202,
"WorkflowId": "",
"TaskId": "n11a6d01c-0ec6-4efc-bd14-97a921d01d3f",
"ScheduleTaskId": "cql-hjlx38yl",
"TaskGroupId": "a5d814828-452c-46f6-b128-19c1a3249bf0",
"ProjectId": "1486446569620893696",
"CreatorUin": "100022187073",
"OperatorUin": "100022187073",
"OwnerUin": "100022187073",
"AppId": "1257305888",
"Status": 3,
"Nodes": [
{
"Id": "130973",
"TaskId": "n11a6d01c-0ec6-4efc-bd14-97a921d01d3f",
"Name": "nodeTestName",
"NodeType": "INPUT",
"DataSourceType": "MYSQL",
"Description": "testdesc",
"DatasourceId": "914840",
"Config": [
{
"Name": "Type",
"Value": "MYSQL"
},
{
"Name": "splitPk",
"Value": "id"
},
{
"Name": "Database",
"Value": "databasetestname"
},
{
"Name": "TableNames",
"Value": "tabletestname"
},
{
"Name": "PrimaryKey",
"Value": "id"
},
{
"Name": "isNew",
"Value": "true"
},
{
"Name": "PrimaryKey_INPUT_SYMBOL",
"Value": "input"
},
{
"Name": "splitPk_INPUT_SYMBOL",
"Value": "input"
},
{
"Name": "isClean",
"Value": "0"
},
{
"Name": "encoding",
"Value": "utf-8"
}
],
"ExtConfig": [
{
"Name": "x1",
"Value": "300"
},
{
"Name": "y2",
"Value": "260"
},
{
"Name": "iconPosition",
"Value": "left"
},
{
"Name": "size",
"Value": "m"
}
],
"Schema": [
{
"Type": "String",
"Alias": "name",
"Comment": "名字",
"Id": "616042880",
"Name": "name",
"Value": "nihao",
"Properties": [
{
"Name": "exttestname",
"Value": "exttestvalue"
}
]
}
],
"NodeMapping": {
"SourceId": "130973",
"SinkId": "130972",
"SourceSchema": [
{
"Id": "597853056",
"Name": "name",
"Value": "test",
"Type": "String",
"Alias": "name",
"Comment": "名称",
"Properties": [
{
"Name": "exttestname",
"Value": "exttestvalue"
}
]
}
],
"SchemaMappings": [
{
"SourceSchemaId": "597853056",
"SinkSchemaId": "616042880"
}
],
"ExtConfig": [
{
"Name": "Type",
"Value": "MYSQL"
}
]
},
"AppId": "1315051999",
"ProjectId": "1486446569620893696",
"CreatorUin": "100028644005",
"OperatorUin": "100028644005",
"OwnerUin": "100028644005",
"CreateTime": "2022-05-07 10:13:21",
"UpdateTime": "2022-05-07 10:13:21"
}
],
"ExecutorId": "20220331190555092303",
"Mappings": [
{
"SourceId": "130973",
"SinkId": "130972",
"SourceSchema": [
{
"Id": "597853056",
"Name": "name",
"Value": "test",
"Type": "String",
"Alias": "name",
"Comment": "名称",
"Properties": [
{
"Name": "exttestname",
"Value": "exttestvalue"
}
]
}
],
"SchemaMappings": [
{
"SourceSchemaId": "597853056",
"SinkSchemaId": "616042880"
}
],
"ExtConfig": [
{
"Name": "Type",
"Value": "MYSQL"
}
]
}
],
"TaskMode": "1",
"Incharge": "100028625403",
"OfflineTaskAddEntity": {
"WorkflowName": "",
"DependencyWorkflow": "",
"StartTime": "2024-04-10 00:00:00",
"EndTime": "2099-12-31 00:00:00",
"CycleType": 1,
"CycleStep": 5,
"DelayTime": 0,
"CrontabExpression": "",
"RetryWait": 3,
"Retriable": 1,
"TryLimit": 3,
"RunPriority": 6,
"ProductName": "DATA_INTEGRATION",
"SelfDepend": 3,
"TaskAction": "",
"ExecutionEndTime": "23:59",
"ExecutionStartTime": "00:00",
"TaskAutoSubmit": true,
"InstanceInitStrategy": "T+0"
},
"ExecutorGroupName": "资源组01",
"InLongManagerUrl": "172.16.64.68:8083",
"InLongStreamId": "f8317843e-68f9-4373-914f-241d7200a9a4",
"InLongManagerVersion": "v17",
"DataProxyUrl": [
"172.16.64.68:8086"
],
"Submit": true,
"InputDatasourceType": "MYSQL",
"OutputDatasourceType": "DLC",
"NumRecordsIn": 1000,
"NumRecordsOut": 1000,
"ReaderDelay": 5,
"NumRestarts": 2,
"CreateTime": "2022-05-07 10:13:21",
"UpdateTime": "2022-05-07 10:13:21",
"LastRunTime": "2022-05-07 10:13:21",
"StopTime": "2022-05-07 10:13:21",
"HasVersion": true,
"Locked": true,
"Locker": "100022187073",
"RunningCu": 2,
"TaskAlarmRegularList": [
"1769,1768"
],
"SwitchResource": 1,
"ReadPhase": 0,
"InstanceVersion": 12,
"ArrangeSpaceTaskId": "20230112170349643",
"OfflineTaskStatus": 1,
"Config": [
{
"Name": "Type",
"Value": "MYSQL"
}
],
"ExtConfig": [
{
"Name": "Type",
"Value": "MYSQL"
}
],
"ExecuteContext": [
{
"Name": "Type",
"Value": "MYSQL"
}
]
},
"AgentStatus": {
"Running": 0,
"Abnormal": 0,
"InOperation": 0
},
"TaskVersion": {
"InstanceVersion": 12,
"VersionDesc": "版本描述",
"ChangeType": 0,
"SubmitterUin": "100006908545",
"InstanceDate": "2022-09-29 16:40:38",
"InstanceStatus": 0
},
"RequestId": "4ec1ea77-7729-47bc-b541-e73412fc5fd7"
}
}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 | 操作不支持。 |
