管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>消息队列 CKafka 版>ckafkaCN API 2017>数据同步相关接口>获取数据同步任务列表

获取数据同步任务列表

最近更新时间：2019-07-22 13:16:20

我的收藏

本页目录：

1. 接口描述

接口请求域名：ckafka.api.qcloud.com 本接口（ListConnector）用于获取数据同步任务列表。

2. 输入参数

以下请求参数列表仅列出了接口请求参数，其它参数见 公共请求参数 页面。
参数名称
必选
类型
描述
connectId
否
Int
connectorId，根据该参数指定 connector 过滤。
searchWord
否
String
（过滤条件）按照 connector 名称过滤，支持模糊查询。
offset
否
Int
偏移量，不填默认为0。
limit
否
Int
返回数量，不填则默认50，最大值50 。

3. 输出参数

参数名称
类型
描述
totalCount
Int
符合条件的 connector 数量。
connectorList
Array
数据同步任务列表。
connectorList::connectorId
String
connectorId。
connectorList::name
String
connector 名称。
connectorList::type
String
connector 类型。 source：导入数据到 Kafka；sink：将数据从 Kafka 导出。
connectorList::connectorClass
String
执行该任务的 class 名称。
connectorList::sourceRegion
String
源所在地域。
connectorList::source
String
源地址。
connectorList::sinkRegion
String
目的所在地域。
connectorList::sink
String
目的地址。
connectorList::status
String
connector 当前状态。 该状态展示有一定的延迟，任务状态可通过 GetConnectorStatus 接口 获取。
UNASSIGNED：任务还未分配；RUNNING：connector 正在运行；PAUSED：connector 已经暂停；FAILED：任务失败；DESTROYED：任务销毁。
connectorList::description
String
connector 描述信息。
connectorList::ctime
String
创建时间。
connectorList::mtime
String
修改时间。

4. 示例

输入：
 https://domain/v2/index.php?Action=ListConnector&<公共请求参数>
输出：
{
    "code":0,
    "codeDesc":"Success",
    "message":"ok",
    "data":{
        "totalCount":2,
        "connectorList":[
            {
                "connectorId":"1",
                "name":"connector-ckafka-xxxxxxxx",
                "type":"source",
                "connectorClass":"com.tencent.ckafka.replicator.K2KSourceConnector",
                "sourceRegion":"sh",
                "source":"ckafka-xxxxxxxx",
                "sinkRegion":"sh",
                "sink":"ckafka-xxxxxxxx",
                "status":"RUNNING",
                "description":"",
                "ctime":"2019-07-12 17:13:46",
                "mtime":"2019-07-12 17:13:46"
            },
            {
                "connectorId":"2",
                "name":"connector-ckafka-xxxxxxx",
                "type":"source",
                "connectorClass":"com.tencent.ckafka.replicator.K2KSourceConnector",
                "sourceRegion":"sh",
                "source":"ckafka-xxxxxxxx",
                "sinkRegion":"sh",
                "sink":"ckafka-xxxxxxxx",
                "status":"RUNNING",
                "description":"",
                "ctime":"2019-07-12 17:13:50",
                "mtime":"2019-07-12 17:13:50"
            }
        ]
    }
}

中国站
目录