Skip to main content

Query Schema Comparison Object Results

Query object-level comparison results for a specified schema comparison execution, including source DDL, target DDL, and whether the objects are consistent.

Request URL: /openapi/v1/compareschema/describeSchemaCompareTask

Request Method: GET

Before You Call

Request Parameters

ParameterTypeRequiredDescriptionExample
taskIdStringYesSchema comparison main task ID.cc-th6j3fs58y
execIdLongYesSchema comparison subtask ID.46958
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.Lh9l2VRM-djkefYZnfjjt7MKdekw9FOC
dataObjectPaginated object-level comparison results. See the fields below.See the example below
messageStringError message returned when the request fails.exec not found

data Fields

ParameterTypeDescriptionExample
taskIdStringSchema comparison main task ID.cc-th6j3fs58y
execIdLongSchema comparison subtask ID.46958
pageNumIntegerCurrent page number.1
pageSizeIntegerNumber of records per page.30
totalIntegerTotal number of object results.1
compareResultsArrayObject-level comparison result list.See the fields below

compareResults Fields

ParameterTypeDescriptionExample
progressIdIntegerResult identifier for a single object. Use it to query correction SQL.388425
sourceDbNameStringSource database or schema name for the object.9zdbtest2
sourceObjectNameStringSource object name. Three-level data sources may return the value in schema.table format.sbtest1
targetDbNameStringTarget database or schema name for the object.9zdbtest3
targetObjectNameStringTarget object name. Three-level data sources may return the value in schema.table format.sbtest1
statusStringObject comparison status. Valid values include notstarted, running, failed, and success.success
compareResultBooleanWhether the object schema is consistent. true means consistent, and false means inconsistent.false
createTimeStringTime when object comparison started.2026-06-25 08:47:50Z
endTimeStringTime when object comparison ended.2026-06-25 08:47:55Z
sourceDdlStringSource object DDL.CREATE TABLE ...
targetDdlStringTarget object DDL.CREATE TABLE ...

Request Example

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

Successful Invocation Example

{
"success": true,
"requestId": "Lh9l2VRM-djkefYZnfjjt7MKdekw9FOC",
"data": {
"taskId": "cc-th6j3fs58y",
"execId": 46958,
"pageNum": 1,
"pageSize": 30,
"total": 1,
"compareResults": [
{
"progressId": 388425,
"sourceDbName": "9zdbtest2",
"sourceObjectName": "sbtest1",
"targetDbName": "9zdbtest3",
"targetObjectName": "sbtest1",
"status": "success",
"compareResult": false,
"sourceDdl": "CREATE TABLE `sbtest1` (...)",
"targetDdl": ""
}
]
}
}