文档首页/ 数据接入服务 DIS/ API参考/ API说明/ 转储任务管理/ 查询当前通道转储任务转储日志
更新时间:2025-11-03 GMT+08:00
分享

查询当前通道转储任务转储日志

功能介绍

本接口用于查询当前通道转储任务的转储日志。

调用方法

请参见如何调用API

URI

POST /v1/transfertasklog/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释

转储任务ID。

约束限制

不涉及

取值范围

由英文字母和数字组成,且长度为19个字符。

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。请参见认证鉴权-Token认证

约束限制

不涉及

取值范围

长度为[1-32768]个字符。

默认取值

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

order

String

参数解释

日志排序方式。

约束限制

不涉及

取值范围

  • desc: 降序排列。

  • asc: 升序排列。

默认取值

desc

sortBy

String

参数解释

日志排序的依据,通常搭配order字段来使用,默认是按照创建时间降序排列。

约束限制

不涉及

取值范围

  • createTimeStr: 依据创建时间排序。

  • startTime: 依据开始时间排序。

  • endTime: 依据结束时间排序。

  • state:依据转储任务状态排序。

  • records:依据记录数排序。

  • readRecords:依据读取记录数排序。

  • dataSize: 依据数据量(字节)排序。

默认取值

createTimeStr

pageInfo

Object

日志显示页数和条数。

表4 pageInfo_descriptor

参数

是否必选

参数类型

描述

pageIndex

Integer

参数解释

指定查看转储日志的页数。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

pageTotal

Integer

参数解释

指定转储日志当前页的日志总条数,默认为10,表示查看当前转储日志页的总条数为10条。

约束限制

不涉及

取值范围

不涉及

默认取值

10

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

totalNum

Integer

参数解释

转储日志总条数。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

message

String

参数解释

操作失败时此处为详细错误信息,操作成功时此字段可能为null。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

errorCode

String

参数解释

错误码。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

transferTaskLogList

Array of transferTaskLogListResult objects

参数解释

当前转储任务的转储日志列表详情。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表6 transferTaskLogListResult

参数

参数类型

描述

transferTaskId

String

参数解释

转储任务ID。

约束限制

不涉及

取值范围

由英文字母和数字组成,且长度为19个字符。

默认取值

不涉及

destinationType

String

参数解释

转储任务类型。

约束限制

不涉及

取值范围

不涉及

默认取值

OBS

startTime

Integer

参数解释

转储任务开始时间,Unix 时间戳格式,单位是毫秒。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

endTime

Integer

参数解释

转储任务结束时间,Unix 时间戳格式,单位是毫秒。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

transferBytes

Long

参数解释

转储数据量,单位为字节。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

transferRecordsNum

Long

参数解释

一个数据转储周期内转储的记录数。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

streamId

String

参数解释

转储任务所属通道id。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

projectId

String

参数解释

项目id。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

transferFileName

String

参数解释

转储任务名称,由“转储任务id.通道名称.创建时间”拼接而成,值唯一。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求示例

查询当前通道转储任务的转储日志。

POST https://{Endpoint}/v1/transfertasklog/{task_id}

{
  "order" : "desc",
  "sortBy" : "createTimeStr",
  "pageInfo" : [ {
    "pageIndex" : 1
  }, {
    "pageIndex" : 10
  } ]
}

响应示例

状态码:200

正常返回

{
  "errorCode" : -1,
  "totalNum" : 100,
  "message" : null,
  "isStreamFound" : null,
  "streamData" : null,
  "streamDataList" : null,
  "transferTaskList" : null,
  "monitorData" : null,
  "transferTaskLogList" : {
    "transferTaskId" : "CDaRPdvKUfZrAhzTaYs",
    "state" : 0,
    "destinationType" : "OBS",
    "startTime" : 1756539753280,
    "endTime" : 1756540056070,
    "transferBytes" : 30718683,
    "transferRecordsNum" : 32943,
    "transformRecordsNum" : 0,
    "streamId" : "hFKqKEhCZgNayyIS8Zv",
    "projectId" : "575ae927fc644f22b5c5af5209b7cf51",
    "transferFileName" : "CDaRPdvKUfZrAhzTaYs.disMonitorTest.0.1756539753290",
    "num" : 0
  }
}

状态码

状态码

描述

200

正常返回

错误码

请参见错误码

相关文档