消息队列 CKafka 版查询Datahub任务列表-其他接口-API 中心-腾讯云

1. 接口描述

接口请求域名： ckafka.tencentcloudapi.com 。

查询Datahub任务列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDatahubTasks。
Version	是	String	公共参数，本接口取值：2019-08-19。
Region	是	String	公共参数，详见产品支持的地域列表。
Limit	否	Integer	返回数量，默认为20，最大值为100 示例值：20
Offset	否	Integer	分页偏移量，默认为0 示例值：0
SearchWord	否	String	过滤条件，按照 TaskName 过滤，支持模糊查询示例值：search-test
TargetType	否	String	转储的目标类型示例值：KAFKA
TaskType	否	String	任务类型，SOURCE数据接入，SINK数据流出示例值：SINK
SourceType	否	String	转储的源类型示例值：KAFKA
Resource	否	String	转储的资源示例值：resource-test

3. 输出参数

参数名称	类型	描述
Result	DescribeDatahubTasksRes	返回任务查询结果示例值：{"TotalCount":1,"TaskList":[{"Status":1,"TaskId":"task-test","TaskName":"task测试","TaskType":"SINK","SourceResource":{"Type":"KAFKA","KafkaParam":{"SelfBuilt":false,"Resource":"ckafka-test","Topic":"topic-test","OffsetType":"timestamp","StartTime":1635339533,"ResourceName":"resourceName-test","ZoneId":100003}},"TargetResource":{"Type":"EB","EventBusParam":{"Type":"COS","SelfBuilt":false,"Resource":"resource-test","Namespace":"default","FunctionName":"functionName-test","Qualifier":"$LATEST"}}}]}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询Datahub任务列表

输入示例

POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatahubTasks
<公共请求参数>

{
    "TaskType": "SOURCE",
    "Limit": "20",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "TaskList": [
                {
                    "TaskName": "mytask",
                    "TaskType": "SOURCE",
                    "SourceResource": {
                        "Type": "HTTP",
                        "KafkaParam": null,
                        "EventBusParam": null,
                        "MongoDBParam": null,
                        "TdwParam": null,
                        "EsParam": null,
                        "DtsParam": null,
                        "ClickHouseParam": null,
                        "ClsParam": null,
                        "CosParam": null,
                        "MySQLParam": null,
                        "MqttParam": null,
                        "PostgreSQLParam": null,
                        "MariaDBParam": null,
                        "SQLServerParam": null,
                        "CtsdbParam": null,
                        "TopicParam": null,
                        "ScfParam": null
                    },
                    "TargetResource": {
                        "Type": "KAFKA",
                        "KafkaParam": {
                            "Topic": "topic-1",
                            "OffsetType": null,
                            "StartTime": null,
                            "ResourceName": "test-public-network",
                            "ZoneId": 100006,
                            "TopicId": null,
                            "PartitionNum": null,
                            "EnableToleration": null,
                            "QpsLimit": 2000,
                            "UseTableMapping": false,
                            "TableMappings": null,
                            "CompressionType": "none",
                            "UseAutoCreateTopic": false,
                            "MsgMultiple": 1,
                            "ConnectorSyncType": "",
                            "KeepPartition": false,
                            "SelfBuilt": false,
                            "Resource": "ckafka-wdvgwwx2"
                        },
                        "EventBusParam": null,
                        "MongoDBParam": null,
                        "TdwParam": null,
                        "EsParam": null,
                        "DtsParam": null,
                        "ClickHouseParam": null,
                        "ClsParam": null,
                        "CosParam": null,
                        "MySQLParam": null,
                        "MqttParam": null,
                        "PostgreSQLParam": null,
                        "MariaDBParam": null,
                        "SQLServerParam": null,
                        "CtsdbParam": null,
                        "TopicParam": null,
                        "ScfParam": null
                    },
                    "TaskId": "task-y9799wbn",
                    "DatahubId": "datahub-y9799wbn",
                    "Status": 1,
                    "CreateTime": "2024-12-04 16:22:23",
                    "ErrorMessage": "运行中",
                    "TaskProgress": 36,
                    "TaskCurrentStep": "FINISH",
                    "StepList": []
                }
            ]
        },
        "RequestId": "08e8fe64-062f-4e15-88fd-aecdf848bf3e"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.InstanceNotExist	实例不存在。
InvalidParameterValue.NotAllowedEmpty	参数不允许为空。