1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
查询Datahub任务信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDatahubTask。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TaskId | 是 | String | 任务id 示例值：xxx |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | DescribeDatahubTaskRes | 返回结果 示例值：xxx |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询Datahub任务信息
输入示例
POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatahubTask
<公共请求参数>
{
"TaskId": "xx"
}输出示例
{
"Response": {
"Result": {
"Status": 0,
"TransformsParam": {
"KeepMetadata": true,
"OutputFormat": "xx",
"SourceType": "xx",
"FilterParam": [
{
"MatchMode": "xx",
"Type": "xx",
"Value": "xx",
"Key": "xx"
}
],
"FailureParam": {
"RetryInterval": 1,
"TopicParam": {
"TopicId": "xx",
"OffsetType": "xx",
"Resource": "xx",
"StartTime": 1
},
"KafkaParam": {
"TopicId": "xx",
"Resource": "xx",
"PartitionNum": 0,
"QpsLimit": 1,
"EnableToleration": true,
"SelfBuilt": true,
"Topic": "xx",
"OffsetType": "xx",
"StartTime": 1,
"UseTableMapping": true,
"ResourceName": "xx",
"ZoneId": 0,
"TableMappings": [
{
"Topic": "xx",
"Table": "xx",
"TopicId": "xx",
"Database": "xx"
}
]
},
"MaxRetryAttempts": 1,
"Type": "xx",
"DlqType": "xx"
},
"Content": "xx",
"Result": "xx",
"FieldChain": [
{
"AnalyseJsonResult": "xx",
"SecondaryAnalyseJsonResult": "xx",
"Analyse": {
"Regex": "xx",
"InputValueType": "xx",
"InputValue": "xx",
"Format": "xx"
},
"SMT": [
{
"ValueOperates": [
{
"Result": "xx",
"Replace": {
"NewValue": "xx",
"OldValue": "xx"
},
"Substr": {
"Start": 0,
"End": 0
},
"Split": {
"Regex": "xx"
},
"KV": {
"Regex": "xx",
"KeepOriginalKey": "xx",
"Delimiter": "xx"
},
"Date": {
"TargetType": "xx",
"TimeZone": "xx",
"Format": "xx"
},
"Type": "xx",
"RegexReplace": {
"Regex": "xx",
"NewValue": "xx"
}
}
],
"Value": "xx",
"SchemeType": "xx",
"OriginalValue": "xx",
"Key": "xx",
"Operate": "xx",
"ValueOperate": {
"Result": "xx",
"Replace": {
"NewValue": "xx",
"OldValue": "xx"
},
"Substr": {
"Start": 0,
"End": 0
},
"Split": {
"Regex": "xx"
},
"KV": {
"Regex": "xx",
"KeepOriginalKey": "xx",
"Delimiter": "xx"
},
"Date": {
"TargetType": "xx",
"TimeZone": "xx",
"Format": "xx"
},
"Type": "xx",
"RegexReplace": {
"Regex": "xx",
"NewValue": "xx"
}
}
}
],
"SecondaryAnalyseResult": [
{
"ValueOperates": [
{
"Result": "xx",
"Replace": {
"NewValue": "xx",
"OldValue": "xx"
},
"Substr": {
"Start": 0,
"End": 0
},
"Split": {
"Regex": "xx"
},
"KV": {
"Regex": "xx",
"KeepOriginalKey": "xx",
"Delimiter": "xx"
},
"Date": {
"TargetType": "xx",
"TimeZone": "xx",
"Format": "xx"
},
"Type": "xx",
"RegexReplace": {
"Regex": "xx",
"NewValue": "xx"
}
}
],
"Value": "xx",
"SchemeType": "xx",
"OriginalValue": "xx",
"Key": "xx",
"Operate": "xx"
}
],
"SecondaryAnalyse": {
"Regex": "xx"
},
"Result": "xx",
"AnalyseResult": [
{
"OriginalValue": "xx",
"Operate": "xx",
"Value": "xx",
"Key": "xx",
"SchemeType": "xx"
}
]
}
],
"RowParam": {
"RowContent": "xx",
"KeyValueDelimiter": "xx",
"EntryDelimiter": "xx"
}
},
"Tags": [
{
"TagKey": "xx",
"TagValue": "xx"
}
],
"SchemaId": "xx",
"ErrorMessage": "xx",
"TargetResource": {
"EventBusParam": {
"Resource": "xx",
"FunctionName": "xx",
"Namespace": "xx",
"SelfBuilt": true,
"Type": "xx",
"Qualifier": "xx"
},
"ClickHouseParam": {
"UserName": "xx",
"Resource": "xx",
"DropCls": {
"DropInvalidMessageToCls": true,
"DropClsTopicId": "xx",
"DropClsRegion": "xx",
"DropClsLogSet": "xx",
"DropClsOwneruin": "xx"
},
"UniqVpcId": "xx",
"Database": "xx",
"Ip": "xx",
"DropInvalidMessage": true,
"SelfBuilt": true,
"Cluster": "xx",
"ServiceVip": "xx",
"Table": "xx",
"Password": "xx",
"Type": "xx",
"Port": 0,
"Schema": [
{
"ColumnName": "xx",
"Type": "xx",
"JsonKey": "xx",
"AllowNull": true
}
]
},
"CtsdbParam": {
"Resource": "xx",
"CtsdbMetric": "xx"
},
"TdwParam": {
"Tid": "xx",
"Bid": "xx",
"TdwHost": "xx",
"IsDomestic": true,
"TdwPort": 0
},
"MySQLParam": {
"OutputFormat": "xx",
"DropCls": {
"DropInvalidMessageToCls": true,
"DropClsTopicId": "xx",
"DropClsRegion": "xx",
"DropClsLogSet": "xx",
"DropClsOwneruin": "xx"
},
"DataSourceIncrementMode": "xx",
"DataSourceMonitorMode": "xx",
"IncludeContentChanges": "xx",
"DataTargetPrimaryKeyField": "xx",
"TopicReplacement": "xx",
"TopicRegex": "xx",
"DataTargetInsertMode": "xx",
"DataSourceIncrementColumn": "xx",
"Resource": "xx",
"Database": "xx",
"DdlTopic": "xx",
"IncludeQuery": true,
"DataTargetRecordMapping": [
{
"JsonKey": "xx",
"ColumnName": "xx",
"AutoIncrement": true,
"DefaultValue": "xx",
"ExtraInfo": "xx",
"AllowNull": true,
"ColumnSize": "xx",
"Type": "xx",
"DecimalDigits": "xx"
}
],
"DataSourceMonitorResource": "xx",
"KeyColumns": "xx",
"RecordWithSchema": true,
"DropInvalidMessage": true,
"SnapshotMode": "xx",
"IsTablePrefix": true,
"Table": "xx",
"DataSourceStartFrom": "xx"
},
"CosParam": {
"FormatOutputType": "xx",
"DirectoryTimeFormat": "xx",
"ObjectKey": "xx",
"BucketName": "xx",
"AggregateBatchSize": 1,
"ObjectKeyPrefix": "xx",
"Region": "xx",
"AggregateInterval": 1
},
"TopicParam": {
"TopicId": "xx",
"OffsetType": "xx",
"Resource": "xx",
"StartTime": 1
},
"KafkaParam": {
"TopicId": "xx",
"Resource": "xx",
"PartitionNum": 0,
"QpsLimit": 1,
"EnableToleration": true,
"SelfBuilt": true,
"Topic": "xx",
"OffsetType": "xx",
"StartTime": 1,
"UseTableMapping": true,
"ResourceName": "xx",
"ZoneId": 0,
"TableMappings": [
{
"Topic": "xx",
"Table": "xx",
"TopicId": "xx",
"Database": "xx"
}
]
},
"EsParam": {
"UserName": "xx",
"Index": "xx",
"Resource": "xx",
"IndexType": "xx",
"UniqVpcId": "xx",
"DropInvalidMessage": true,
"DateFormat": "xx",
"SelfBuilt": true,
"DropInvalidJsonMessage": true,
"ServiceVip": "xx",
"DropCls": {
"DropInvalidMessageToCls": true,
"DropClsTopicId": "xx",
"DropClsRegion": "xx",
"DropClsLogSet": "xx",
"DropClsOwneruin": "xx"
},
"Password": "xx",
"Port": 0,
"DatabasePrimaryKey": "xx",
"ContentKey": "xx",
"DocumentIdField": "xx"
},
"DtsParam": {
"Resource": "xx",
"Ip": "xx",
"TranSql": true,
"GroupId": "xx",
"Topic": "xx",
"GroupUser": "xx",
"GroupPassword": "xx",
"Port": 0
},
"MongoDBParam": {
"UserName": "xx",
"CopyExisting": true,
"Pipeline": "xx",
"ListeningEvent": "xx",
"Resource": "xx",
"ReadPreference": "xx",
"Database": "xx",
"Ip": "xx",
"Collection": "xx",
"SelfBuilt": true,
"Password": "xx",
"Port": 0
},
"PostgreSQLParam": {
"DataTargetInsertMode": "xx",
"Resource": "xx",
"Database": "xx",
"DropInvalidMessage": true,
"DataTargetRecordMapping": [
{
"JsonKey": "xx",
"ColumnName": "xx",
"AutoIncrement": true,
"DefaultValue": "xx",
"ExtraInfo": "xx",
"AllowNull": true,
"ColumnSize": "xx",
"Type": "xx",
"DecimalDigits": "xx"
}
],
"SnapshotMode": "xx",
"PluginName": "xx",
"DataFormat": "xx",
"KeyColumns": "xx",
"RecordWithSchema": true,
"DataTargetPrimaryKeyField": "xx",
"Table": "xx",
"IsTableRegular": true
},
"SQLServerParam": {
"Table": "xx",
"SnapshotMode": "xx",
"Resource": "xx",
"Database": "xx"
},
"MariaDBParam": {
"OutputFormat": "xx",
"Resource": "xx",
"Database": "xx",
"IncludeQuery": true,
"SnapshotMode": "xx",
"KeyColumns": "xx",
"IsTablePrefix": true,
"IncludeContentChanges": "xx",
"Table": "xx",
"RecordWithSchema": true
},
"Type": "xx",
"ClsParam": {
"LogSet": "xx",
"TimeField": "xx",
"Resource": "xx",
"ContentKey": "xx",
"DecodeJson": true
}
},
"TaskType": "xx",
"Connections": [
{
"TopicId": "xx",
"TopicName": "xx",
"GroupId": "xx"
}
],
"TransformParam": {
"Regex": "xx",
"OutputFormat": "xx",
"SourceType": "xx",
"FilterParam": [
{
"MatchMode": "xx",
"Type": "xx",
"Value": "xx",
"Key": "xx"
}
],
"UseEventBus": true,
"FailureParam": {
"RetryInterval": 1,
"TopicParam": {
"TopicId": "xx",
"OffsetType": "xx",
"Resource": "xx",
"StartTime": 1
},
"KafkaParam": {
"TopicId": "xx",
"Resource": "xx",
"PartitionNum": 0,
"QpsLimit": 1,
"EnableToleration": true,
"SelfBuilt": true,
"Topic": "xx",
"OffsetType": "xx",
"StartTime": 1,
"UseTableMapping": true,
"ResourceName": "xx",
"ZoneId": 0,
"TableMappings": [
{
"Topic": "xx",
"Table": "xx",
"TopicId": "xx",
"Database": "xx"
}
]
},
"MaxRetryAttempts": 1,
"Type": "xx",
"DlqType": "xx"
},
"Content": "xx",
"AnalysisFormat": "xx",
"MapParam": [
{
"Type": "xx",
"Value": "xx",
"Key": "xx"
}
],
"AnalyseResult": [
{
"Type": "xx",
"Value": "xx",
"Key": "xx"
}
],
"Result": "xx"
},
"TaskId": "xx",
"DatahubId": "xx",
"SourceResource": {
"EventBusParam": {
"Resource": "xx",
"FunctionName": "xx",
"Namespace": "xx",
"SelfBuilt": true,
"Type": "xx",
"Qualifier": "xx"
},
"ClickHouseParam": {
"UserName": "xx",
"Resource": "xx",
"UniqVpcId": "xx",
"Database": "xx",
"Ip": "xx",
"DropInvalidMessage": true,
"SelfBuilt": true,
"Cluster": "xx",
"ServiceVip": "xx",
"Table": "xx",
"Password": "xx",
"Type": "xx",
"Port": 0,
"Schema": [
{
"ColumnName": "xx",
"Type": "xx",
"JsonKey": "xx",
"AllowNull": true
}
]
},
"CtsdbParam": {
"Resource": "xx",
"CtsdbMetric": "xx"
},
"TdwParam": {
"Tid": "xx",
"Bid": "xx",
"TdwHost": "xx",
"IsDomestic": true,
"TdwPort": 0
},
"MySQLParam": {
"OutputFormat": "xx",
"DataSourceIncrementMode": "xx",
"DataSourceMonitorMode": "xx",
"IncludeContentChanges": "xx",
"DataTargetPrimaryKeyField": "xx",
"TopicReplacement": "xx",
"TopicRegex": "xx",
"DataTargetInsertMode": "xx",
"DataSourceIncrementColumn": "xx",
"Resource": "xx",
"Database": "xx",
"DdlTopic": "xx",
"IncludeQuery": true,
"DataTargetRecordMapping": [
{
"JsonKey": "xx",
"ColumnName": "xx",
"AutoIncrement": true,
"DefaultValue": "xx",
"ExtraInfo": "xx",
"AllowNull": true,
"ColumnSize": "xx",
"Type": "xx",
"DecimalDigits": "xx"
}
],
"DataSourceMonitorResource": "xx",
"KeyColumns": "xx",
"RecordWithSchema": true,
"DropInvalidMessage": true,
"SnapshotMode": "xx",
"IsTablePrefix": true,
"Table": "xx",
"DataSourceStartFrom": "xx"
},
"CosParam": {
"FormatOutputType": "xx",
"DirectoryTimeFormat": "xx",
"ObjectKey": "xx",
"BucketName": "xx",
"AggregateBatchSize": 1,
"ObjectKeyPrefix": "xx",
"Region": "xx",
"AggregateInterval": 1
},
"EsParam": {
"UserName": "xx",
"Index": "xx",
"Resource": "xx",
"IndexType": "xx",
"UniqVpcId": "xx",
"DropInvalidMessage": true,
"DateFormat": "xx",
"SelfBuilt": true,
"ServiceVip": "xx",
"DatabasePrimaryKey": "xx",
"Password": "xx",
"DropInvalidJsonMessage": true,
"Port": 0,
"ContentKey": "xx",
"DocumentIdField": "xx"
},
"DtsParam": {
"Resource": "xx",
"Ip": "xx",
"TranSql": true,
"GroupId": "xx",
"Topic": "xx",
"GroupUser": "xx",
"GroupPassword": "xx",
"Port": 0
},
"MongoDBParam": {
"UserName": "xx",
"CopyExisting": true,
"Pipeline": "xx",
"ListeningEvent": "xx",
"Resource": "xx",
"ReadPreference": "xx",
"Database": "xx",
"Ip": "xx",
"Collection": "xx",
"SelfBuilt": true,
"Password": "xx",
"Port": 0
},
"PostgreSQLParam": {
"DataTargetInsertMode": "xx",
"Resource": "xx",
"Database": "xx",
"DropInvalidMessage": true,
"SnapshotMode": "xx",
"PluginName": "xx",
"DataFormat": "xx",
"KeyColumns": "xx",
"RecordWithSchema": true,
"DataTargetPrimaryKeyField": "xx",
"Table": "xx",
"IsTableRegular": true
},
"SQLServerParam": {
"Table": "xx",
"SnapshotMode": "xx",
"Resource": "xx",
"Database": "xx"
},
"MariaDBParam": {
"OutputFormat": "xx",
"Resource": "xx",
"Database": "xx",
"IncludeQuery": true,
"SnapshotMode": "xx",
"KeyColumns": "xx",
"IsTablePrefix": true,
"IncludeContentChanges": "xx",
"Table": "xx",
"RecordWithSchema": true
},
"Type": "xx",
"ClsParam": {
"LogSet": "xx",
"TimeField": "xx",
"Resource": "xx",
"ContentKey": "xx",
"DecodeJson": true
}
},
"SchemaName": "xx",
"TaskName": "xx",
"CreateTime": "xx"
},
"RequestId": "xx"
}
}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签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |