GetStructSyncJobAnalyzeResult API Reference - Data Management - Alibaba Cloud - Data Management

Queries the analysis results of a schema synchronization task.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetStructSyncJobAnalyzeResult

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ID of the ticket.	1342355
CompareType	string	No	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
PageNumber	integer	No	The page number to return.	1
PageSize	integer	No	The number of entries per page.	20
Tid	integer	No	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 elements

Element	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	1810E635-A2D7-428B-BAA9-85DAEB9B1A77
Success	boolean	Whether the request was successful.	true
ErrorMessage	string	The error message.	UnknownError
ErrorCode	string	The error code.	UnknownError
StructSyncJobAnalyzeResult	object	The analysis result of the schema synchronization task.
SummaryList	array<object>	The statistics on the analysis results.
	object	The statistics on an analysis result.
CompareType	string	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
Count	integer	The number of tables.	1
ResultList	array<object>	The details of the analysis results.
	object	The details of an analysis result.
SourceTableName	string	The name of the source table.	helloz_bak
TargetTableName	string	The name of the destination table.	helloz_bak
Script	string	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

Success response

JSON format

{
  "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;"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.