Querying the Log of the Dump Task in the Current Stream

Function

This API is used to query the log of the dump task running in the current stream.

Calling Method

For details, see Calling APIs.

URI

POST /v1/transfertasklog/{task_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	Definition Dump task ID Constraints N/A Range The value contains 19 characters, including letters and digits. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. For details, see Token-based Authentication. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
order	No	String	Definition Log sorting mode Constraints N/A Range desc: descending order asc: ascending order Default Value desc
sortBy	No	String	Definition Log sorting criteria. This field is used together with the order field. By default, logs are sorted by creation time in descending order. Constraints N/A Range createTimeStr: sorted by creation time startTime: sorted by start time endTime: sorted by end time state: sorted by dump task status records: sorted by the number of records readRecords: sorted by the number of read records dataSize: sorted by data volume (bytes) Default Value createTimeStr
pageInfo	No	Object	Number of pages and logs displayed

**Table 4** pageInfo_descriptor
Parameter	Mandatory	Type	Description
pageIndex	Yes	Integer	Definition Specific page of dumped logs Constraints N/A Range N/A Default Value N/A
pageTotal	Yes	Integer	Definition Total number of logs on the current page. The default value is 10, indicating that there are 10 logs on the current page. Constraints N/A Range N/A Default Value 10

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
totalNum	Integer	Definition Total number of dumped logs Constraints N/A Range N/A Default Value N/A
message	String	Definition If the operation fails, the details of the error are displayed. If the operation is successful, this field may be null. Constraints N/A Range N/A Default Value N/A
errorCode	String	Definition Error code Constraints N/A Range N/A Default Value N/A
transferTaskLogList	Array of transferTaskLogListResult objects	Definition Dump logs of the current dump task Constraints N/A Range N/A Default Value N/A

**Table 6** transferTaskLogListResult
Parameter	Type	Description
transferTaskId	String	Definition Dump task ID Constraints N/A Range The value contains 19 characters, including letters and digits. Default Value N/A
destinationType	String	Definition Type of the dump task Constraints N/A Range N/A Default Value OBS
startTime	Integer	Definition Dump task start time. It is a UNIX timestamp, accurate to millisecond. Constraints N/A Range N/A Default Value N/A
endTime	Integer	Definition Dump task end time. It is a UNIX timestamp, accurate to millisecond. Constraints N/A Range N/A Default Value N/A
transferBytes	Long	Definition Size of the dumped data, in bytes Constraints N/A Range N/A Default Value N/A
transferRecordsNum	Long	Definition Number of records dumped in a data dump period Constraints N/A Range N/A Default Value N/A
streamId	String	Definition Name of the stream to which the dump task belongs Constraints N/A Range N/A Default Value N/A
projectId	String	Definition Project ID Constraints N/A Range N/A Default Value N/A
transferFileName	String	Definition Dump task name, which is composed of the dump task ID, stream name, and creation time. The value must be unique. Constraints N/A Range N/A Default Value N/A

Example Requests

Query the log of the dump task running in the current stream.

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

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

Example Responses

Status code: 200

Normal response

{
  "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
  }
}