All Products
Search
Document Center

Data Management:GetStructSyncJobAnalyzeResult

Last Updated:Apr 18, 2024

Queries the analysis result of a schema synchronization task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:GetStructSyncJobAnalyzeResultRead
  • All Resources
    *
    none
none

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.

SummaryListobject []

The statistics on the analysis results.

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
ResultListobject []

The details of the analysis results.

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