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
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| taskId | String | No | Schema comparison main task ID. If this parameter is omitted, tasks are returned by pagination. | cc-th6j3fs58y |
| pageSize | Integer | No | Number of records per page. Default value: 30. Maximum value: 100. | 30 |
| pageNumber | Integer | No | Page number. The default page starts from 1. | 1 |
Response Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| success | Boolean | Whether the request is successful. | true |
| requestId | String | Request ID, which can be used for troubleshooting and tracing. | Kg1z5GAI-gmnhsLLnimmh7TTdhmo7KGB |
| data | Object | Paginated schema comparison task result. See the fields below. | See the example below |
| message | String | Error message returned when the request fails. | invalid pageSize |
data Fields
| Parameter | Type | Description | Example |
|---|---|---|---|
| pageNumber | Integer | Current page number. | 1 |
| pageSize | Integer | Number of records per page. | 30 |
| total | Integer | Total number of matching tasks. | 1 |
| schemaComparisons | Array | Schema comparison task list. | See the fields below |
schemaComparisons Fields
| Parameter | Type | Description | Example |
|---|---|---|---|
| taskId | String | Schema comparison task ID. | cc-th6j3fs58y |
| taskName | String | Schema comparison task name. | schema_compare_demo |
| status | String | Task status. Common values include notStarted, prechecking, starting, running, failed, and success. | success |
| periodic | String | Comparison mode. ONETIME means one-time comparison, and PERIODIC means scheduled comparison. | ONETIME |
| lastExecId | Long | Latest schema comparison subtask ID. | 46958 |
| createTime | String | Task creation time. | 2026-06-25 08:47:31Z |
| sourceDsId | String | Source data source ID. | ds-ct192k3jlj4f |
| sourceDsName | String | Source data source name. | sqldev-13375 |
| sourceDsType | String | Source data source type. | mysql |
| targetDsId | String | Target data source ID. | ds-d37s953l33d3 |
| targetDsName | String | Target data source name. | 13376 |
| targetDsType | String | Target 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"
}
]
}
}