文档首页/ 分布式消息服务Kafka版/ API参考/ 历史API/ API V2/ Smart Connect/ 查询单个转储任务
更新时间：2025-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询单个转储任务

功能介绍

查询单个转储任务。

当前页面API为历史版本API，未来可能停止维护。请使用查询Smart Connector任务详情。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/connectors/{connector_id}/sink-tasks/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

connector_id

是

String

实例转储ID。

请参考查询实例返回的数据。

task_id

是

String

转储任务ID。
表2 Query参数

参数

是否必选

参数类型

描述

topic-info

否

String

是否包含topic信息。默认是false。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

task_name

String

转储任务名称。

destination_type

String

转储任务类型。

create_time

Long

转储任务创建时间戳。

status

String

转储任务状态。

topics

String

返回任务转存的topics列表或者正则表达式。

obs_destination_descriptor

obs_destination_descriptor object

转存目标的描述。

topics_info

Array of topics_info objects

topic信息。
表4 obs_destination_descriptor

参数

参数类型

描述

consumer_strategy

String

消费启动策略：

  • latest：从Topic最后端开始消费。
  • earliest: 从Topic最前端消息开始消费。

默认是latest。

destination_file_type

String

转储文件格式。目前只支持text格式。

obs_bucket_name

String

存储该通道数据的OBS桶名称。

obs_path

String

存储在obs的路径。

partition_format

String

将转储文件的生成时间使用“yyyy/MM/dd/HH/mm”格式生成分区字符串，用来定义写到OBS的Object文件所在的目录层次结构。

  • yyyy：年
  • yyyy/MM：年/月
  • yyyy/MM/dd：年/月/日
  • yyyy/MM/dd/HH：年/月/日/时
  • yyyy/MM/dd/HH/mm：年/月/日/时/分，例如：2017/11/10/14/49，目录结构就是“2017 > 11 > 10 > 14 > 49”，“2017”表示最外层文件夹。
说明：

数据转储成功后，存储的目录结构为“obs_bucket_path/file_prefix/partition_format”。默认时间是GMT+8 时间

record_delimiter

String

转储文件的记录分隔符，用于分隔写入转储文件的用户数据。

取值范围：

  • 逗号“,”
  • 分号“;”
  • 竖线“|”
  • 换行符“\n”
  • NULL

默认值：换行符“\n”。

deliver_time_interval

Integer

根据用户配置的时间，周期性的将数据导入OBS，若某个时间段内无数据，则此时间段不会生成打包文件。

取值范围：30～900，缺省值：300，单位：秒。

说明：

使用OBS通道转储流式数据时该参数为必选配置。

obs_part_size

Long

每个传输文件多大后就开始上传，单位为byte。

默认值5242880。
表5 topics_info

参数

参数类型

描述

topic

String

topic名称。

partitions

Array of partitions objects

分区列表。
表6 partitions

参数

参数类型

描述

partition_id

String

分区ID。

status

String

运行状态。

last_transfer_offset

String

已转储的消息偏移量。

log_end_offset

String

消息偏移量。

lag

String

积压的消息数。

请求示例

查询指定的转储任务详情。

GET https://{endpoint}/v2/{project_id}/connectors/{connector_id}/sink-tasks/{task_id}?topic-info=true

响应示例

状态码： 200

查询单个转储任务成功。

{
  "task_name" : "obsTransfer-56997523",
  "destination_type" : "OBS",
  "create_time" : 1628126621283,
  "status" : "RUNNING",
  "topics" : "topic-sdk-no-delete",
  "obs_destination_descriptor" : {
    "consumer_strategy" : "earliest",
    "destination_file_type" : "TEXT",
    "obs_bucket_name" : "testobs",
    "obs_path" : "obsTransfer-56997523",
    "partition_format" : "yyyy/MM/dd/HH/mm",
    "record_delimiter" : "",
    "deliver_time_interval" : 300,
    "obs_part_size" : 5242880
  },
  "topics_info" : [ {
    "topic" : "topic-sdk-no-delete",
    "partitions" : [ {
      "partition_id" : "2",
      "status" : "RUNNING",
      "last_transfer_offset" : "3",
      "log_end_offset" : "3",
      "lag" : "0"
    }, {
      "partition_id" : "1",
      "status" : "RUNNING",
      "last_transfer_offset" : "3",
      "log_end_offset" : "3",
      "lag" : "0"
    }, {
      "partition_id" : "0",
      "status" : "RUNNING",
      "last_transfer_offset" : "3",
      "log_end_offset" : "3",
      "lag" : "0"
    } ]
  } ]
}

状态码

状态码

描述

200

查询单个转储任务成功。

错误码

请参见错误码。

父主题： Smart Connect

相关文档