查询Datahub任务列表

最近更新时间:2024-03-12 01:17:07

我的收藏

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 过滤,支持模糊查询
示例值:xxx
TargetType String 转储的目标类型
示例值:xxx
TaskType String 任务类型,SOURCE数据接入,SINK数据流出
示例值:SINK
SourceType String 转储的源类型
示例值:xxx
Resource String 转储的资源
示例值:xxx

3. 输出参数

参数名称 类型 描述
Result DescribeDatahubTasksRes 返回任务查询结果
示例值:xxx
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": "SINK",
    "Limit": "20",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 0,
            "TaskList": [
                {
                    "Status": 0,
                    "TaskId": "xx",
                    "TaskName": "MyTaskName",
                    "TaskType": "SINK",
                    "SourceResource": {
                        "Type": "KAFKA",
                        "KafkaParam": {
                            "SelfBuilt": false,
                            "Resource": "ckafka-7kd5rzza",
                            "Topic": "topic-test",
                            "OffsetType": "timestamp",
                            "StartTime": 1635339533,
                            "ResourceName": "MyCkafkaName",
                            "ZoneId": 200005
                        }
                    },
                    "TargetResource": {
                        "Type": "EB",
                        "EventBusParam": {
                            "Type": "COS",
                            "SelfBuilt": false,
                            "Resource": "target-resource",
                            "Namespace": "default",
                            "FunctionName": "ckafka-7kd5rzza_topic-0cus2p9z_task_1633501781881_schedule",
                            "Qualifier": "$LATEST"
                        }
                    }
                }
            ]
        },
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

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