Skip to main content

List Schema Comparison Tasks

Query schema comparison tasks under the current account. You can also query by a specific schema comparison main task ID.

Request URL: /openapi/v1/compareschema/queryTaskList

Request Method: GET

Request Parameters

ParameterTypeRequiredDescriptionExample
taskIdStringNoSchema comparison main task ID. If this parameter is omitted, tasks are returned by pagination.cc-th6j3fs58y
pageSizeIntegerNoNumber of records per page. Default value: 30. Maximum value: 100.30
pageNumberIntegerNoPage number. The default page starts from 1.1

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID, which can be used for troubleshooting and tracing.Kg1z5GAI-gmnhsLLnimmh7TTdhmo7KGB
dataObjectPaginated schema comparison task result. See the fields below.See the example below
messageStringError message returned when the request fails.invalid pageSize

data Fields

ParameterTypeDescriptionExample
pageNumberIntegerCurrent page number.1
pageSizeIntegerNumber of records per page.30
totalIntegerTotal number of matching tasks.1
schemaComparisonsArraySchema comparison task list.See the fields below

schemaComparisons Fields

ParameterTypeDescriptionExample
taskIdStringSchema comparison task ID.cc-th6j3fs58y
taskNameStringSchema comparison task name.schema_compare_demo
statusStringTask status. Common values include notStarted, prechecking, starting, running, failed, and success.success
periodicStringComparison mode. ONETIME means one-time comparison, and PERIODIC means scheduled comparison.ONETIME
lastExecIdLongLatest schema comparison subtask ID.46958
createTimeStringTask creation time.2026-06-25 08:47:31Z
sourceDsIdStringSource data source ID.ds-ct192k3jlj4f
sourceDsNameStringSource data source name.sqldev-13375
sourceDsTypeStringSource data source type.mysql
targetDsIdStringTarget data source ID.ds-d37s953l33d3
targetDsNameStringTarget data source name.13376
targetDsTypeStringTarget data source type.mysql

Request Example

{
"taskId": "cc-th6j3fs58y",
"pageNumber": 1,
"pageSize": 30
}

Successful Invocation Example

{
"success": true,
"requestId": "Kg1z5GAI-gmnhsLLnimmh7TTdhmo7KGB",
"data": {
"pageNumber": 1,
"pageSize": 30,
"total": 1,
"schemaComparisons": [
{
"taskId": "cc-th6j3fs58y",
"taskName": "schema_compare_demo",
"status": "success",
"periodic": "ONETIME",
"lastExecId": 46958,
"createTime": "2026-06-25 08:47:31Z",
"sourceDsId": "ds-ct192k3jlj4f",
"sourceDsName": "sqldev-13375",
"sourceDsType": "mysql",
"targetDsId": "ds-d37s953l33d3",
"targetDsName": "13376",
"targetDsType": "mysql"
}
]
}
}