All Products
Search
Document Center

Data Management:GetStructSyncJobAnalyzeResult

Last Updated:Oct 21, 2024

Queries the analysis result of a schema synchronization task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

The ID of the ticket.

1342355
CompareTypestringNo

The type of the comparison. Valid values:

  • CREATE_TABLE: compares the created tables.
  • ALTER_TABLE: compares the modified tables.
  • EQUAL_TABLE: compares the identical tables.
  • PASS_TABLE: compares the tables that are skipped during schema synchronization.
  • NOT_COMPARE: does not compare tables.
CREATE_TABLE
PageNumberlongNo

The number of the page to return.

1
PageSizelongNo

The number of entries to return on each page.

20
TidlongNo

The ID of the tenant.

Note To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.
1

Response parameters

ParameterTypeDescriptionExample
object

The schema of the response.

RequestIdstring

The ID of the request.

1810E635-A2D7-428B-BAA9-85DAEB9B1A77
Successboolean

Indicates whether the request is successful.

true
ErrorMessagestring

The error message.

UnknownError
ErrorCodestring

The error code.

UnknownError
StructSyncJobAnalyzeResultobject

The analysis result of the schema synchronization task.

SummaryListarray<object>

The statistics on the analysis results.

Summaryobject

The statistics on an analysis result.

CompareTypestring

The type of the comparison. Valid values:

  • CREATE_TABLE: compares the created tables.
  • ALTER_TABLE: compares the modified tables.
  • EQUAL_TABLE: compares the identical tables.
  • PASS_TABLE: compares the tables that are skipped during schema synchronization.
  • NOT_COMPARE: does not compare tables.
CREATE_TABLE
Countlong

The number of tables.

1
ResultListarray<object>

The details of the analysis results.

Resultobject

The details of an analysis result.

SourceTableNamestring

The name of the source table.

helloz_bak
TargetTableNamestring

The name of the destination table.

helloz_bak
Scriptstring

The SQL script.

/\* origin table\[helloz_bak] exist, target table\[helloz_bak] not exist \*/\n/\* generate \[helloz_bak] create table sql \*/\ncreate table \`helloz_bak\`(\n\t\`id\` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT 'Primary key',\n\t\`gmt_create\` datetime NOT NULL COMMENT 'Creation time',\n\t\`gmt_modified\` datetime NOT NULL COMMENT 'Modification time',\n\t\`num\` int(11) NOT NULL COMMENT 'Number',\n\t\`addr\` varchar(50) CHARACTER SET utf8 COLLATE utf8\_general_ci NOT NULL COMMENT 'Address',\n\tPRIMARY KEY (\`id\`)\n)\nDEFAULT CHARACTER SET=utf8 COLLATE=utf8\_general_ci\nCOMMENT='test'\n\n;

Examples

Sample success responses

JSONformat

{
  "RequestId": "1810E635-A2D7-428B-BAA9-85DAEB9B1A77",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "StructSyncJobAnalyzeResult": {
    "SummaryList": [
      {
        "CompareType": "CREATE_TABLE",
        "Count": 1
      }
    ],
    "ResultList": [
      {
        "SourceTableName": "helloz_bak",
        "TargetTableName": "helloz_bak",
        "Script": "/\\* origin table\\[helloz_bak] exist, target table\\[helloz_bak] not exist \\*/\\n/\\* generate \\[helloz_bak] create table sql \\*/\\ncreate table \\`helloz_bak\\`(\\n\\t\\`id\\` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT 'Primary key',\\n\\t\\`gmt_create\\` datetime NOT NULL COMMENT 'Creation time',\\n\\t\\`gmt_modified\\` datetime NOT NULL COMMENT 'Modification time',\\n\\t\\`num\\` int(11) NOT NULL COMMENT 'Number',\\n\\t\\`addr\\` varchar(50) CHARACTER SET utf8 COLLATE utf8\\_general_ci NOT NULL COMMENT 'Address',\\n\\tPRIMARY KEY (\\`id\\`)\\n)\\nDEFAULT CHARACTER SET=utf8 COLLATE=utf8\\_general_ci\\nCOMMENT='test'\\n\\n;\n"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history