Skip to main content

Query Task Logs

Queries runtime logs for a data replication task or a data comparison task.

Request URL: /openapi/v1/log/query

Request Method: GET

Request Parameters

ParameterTypeRequiredDescriptionExample
taskIdStringNoTask ID.rp-di3twoi1mjzx
taskTypeStringYesTask type. Optional values: replication, dataCompare.replication
directionStringNoLog query direction. Optional values: FORWARD, BACKWARD.FORWARD
startTimeStringNoQuery start time in UTC. The format must be ISO 8601, for example 2026-04-27T00:00:00Z.2026-04-27T00:00:00Z
endTimeStringNoQuery end time in UTC. The format must be ISO 8601, for example 2026-04-28T08:00:00Z.2026-04-28T08:00:00Z
limitIntegerNoMaximum number of returned log records. Default: 1000.10
logTypeStringNoLog type. By default all logs are returned. When querying replication task logs, you can pass read or write.read

Request Example

{
"taskId": "rp-di3twoi1mjzx",
"taskType": "replication",
"startTime": "2026-04-27T00:00:00Z",
"endTime": "2026-04-28T08:00:00Z",
"direction": "BACKWARD",
"limit": 10
}

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID.Dm7u4QKE-flllsCHnhkgp4GPdghy7WXP
dataArrayList of log records, including time and value.{ "time": "2026-04-27 10:03:34Z", "value": "2026-04-27 09:30:39 [INFO] - struct replication end" }

Log Record Fields

ParameterTypeDescription
timeStringIndexed log time.
valueStringLog content.

Successful Invocation Example

{
"success": true,
"requestId": "Dm7u4QKE-flllsCHnhkgp4GPdghy7WXP",
"data": [
{
"time": "2026-04-27 10:03:34Z",
"value": "2026-04-27 09:30:39 [INFO] - struct replication end"
},
{
"time": "2026-04-27 10:03:28Z",
"value": "2026-04-27 09:30:38 [INFO] - replicate table 10/10 [sysbench].[sbtest9] to [sysbench].[sbtest9]"
},
{
"time": "2026-04-27 10:03:25Z",
"value": "2026-04-27 09:30:38 [INFO] - replicate table 9/10 [sysbench].[sbtest8] to [sysbench].[sbtest8]"
},
{
"time": "2026-04-27 10:02:58Z",
"value": "2026-04-27 09:30:38 [INFO] - replicate table 8/10 [sysbench].[sbtest7] to [sysbench].[sbtest7]"
},
{
"time": "2026-04-27 10:02:31Z",
"value": "2026-04-27 09:30:38 [INFO] - replicate table 7/10 [sysbench].[sbtest6] to [sysbench].[sbtest6]"
},
{
"time": "2026-04-27 10:02:09Z",
"value": "2026-04-27 09:30:38 [INFO] - replicate table 6/10 [sysbench].[sbtest5] to [sysbench].[sbtest5]"
},
{
"time": "2026-04-27 10:01:57Z",
"value": "2026-04-27 09:30:38 [INFO] - replicate table 5/10 [sysbench].[sbtest4] to [sysbench].[sbtest4]"
},
{
"time": "2026-04-27 10:01:41Z",
"value": "2026-04-27 09:30:37 [INFO] - replicate table 4/10 [sysbench].[sbtest3] to [sysbench].[sbtest3]"
},
{
"time": "2026-04-27 10:01:16Z",
"value": "2026-04-27 09:30:37 [INFO] - replicate table 3/10 [sysbench].[sbtest2] to [sysbench].[sbtest2]"
},
{
"time": "2026-04-27 10:00:58Z",
"value": "2026-04-27 09:30:37 [INFO] - replicate table 2/10 [sysbench].[sbtest10] to [sysbench].[sbtest10]"
}
]
}