文档首页> 数据接入服务 DIS> API参考> API说明> 转储任务管理> 查询转储任务列表
更新时间：2022-10-20 GMT+08:00
查看PDF

查询转储任务列表

功能介绍

本接口用于查询转储任务列表。

URI

GET /v2/{project_id}/streams/{stream_name}/transfer-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

stream_name

是

String

需要查询的通道名称。

最大长度：60

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total_number

Integer

转储任务总数。

quota

Integer

可创建的转储任务配额。

tasks

Array of TransferTask objects

转储任务列表。
表4 TransferTask

参数

参数类型

描述

task_name

String

转储任务名称。

state

String

转储任务状态。

  • ERROR：错误。

  • STARTING：启动中。

  • PAUSED：已停止。

  • RUNNING：运行中。

  • DELETE：已删除。

  • ABNORMAL：异常。

枚举值：

  • ERROR

  • STARTING

  • PAUSED

  • RUNNING

  • DELETE

  • ABNORMAL

destination_type

String

转储任务类型。

  • OBS：转储到OBS。

  • MRS：转储到MRS。

  • DLI：转储到DLI。

  • CLOUDTABLE：转储到CloudTable。

  • DWS：转储到DWS。

枚举值：

  • OBS

  • MRS

  • DLI

  • CLOUDTABLE

  • DWS

create_time

Long

转储任务创建时间。

last_transfer_timestamp

Long

转储任务最近一次转储时间。

请求示例

查询转储任务列表

GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks

响应示例

状态码： 200

正常返回

{
  "tasks" : [ {
    "task_id" : "As805BudhcH1lDs6gbn",
    "destination_type" : "OBS",
    "task_name" : "newtask",
    "create_time" : 1606554932552,
    "state" : "RUNNING",
    "last_transfer_timestamp" : 1606984428612
  } ],
  "total_number" : 1
}

状态码

状态码

描述

200

正常返回

错误码

请参见错误码。

父主题： 转储任务管理