Call GetStructSyncOrderDetail to query schema synchronization ticket details - Data Management - Alibaba Cloud - Data Management

Retrieves the details of a schema synchronization ticket.

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:GetStructSyncOrderDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ID of the ticket.	43****
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 response parameters.
RequestId	string	The ID of the request.	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Success	boolean	Whether the request was successful.	true
ErrorMessage	string	The error message.	UnknownError
ErrorCode	string	The error code.	UnknownError
StructSyncOrderDetail	object	The details of the schema synchronization ticket.
SourceDatabaseInfo	object	The source database information.
DbId	integer	The ID of the source database.	432532
SearchName	string	The search name of the database.	test
DbType	string	The type of the database engine.	MySQL
EnvType	string	The environment type of the database instance. For more information, see Change the environment type of an instance.	dev
Logic	boolean	Whether the database is a logical database. Valid values: true: The database is a logical database. false: The database is not a logical database	false
TargetDatabaseInfo	object	The destination database information.
DbId	integer	The ID of the destination database.	432543
SearchName	string	The search name of the database.	test
DbType	string	The type of the database engine.	MySQL
EnvType	string	The environment type of the database instance. For more information, see Change the environment type of an instance.	dev
Logic	boolean	Whether the database is a logical database. Valid values: true: The database is a logical database. false: The database is not a logical database	false
SourceType	string	The schema version of the source database. Valid values: DATASOURCE: the default latest version of the system VERSION: a previous schema version that you manually specify	VERSION
SourceVersionInfo	object	The version of the source instance. Note This parameter is displayed only when the value of the SourceType parameter is VERSION.
VersionId	string	The version number.	e179bbb8163dcdcfacda24858bedb4d8006ae2b8
TargetType	string	The schema version of the destination database. Valid values: DATASOURCE: the default latest version of the system VERSION: a previous schema version that you manually specify	DATASOURCE
TargetVersionInfo	object	The version of the destination instance. Note This parameter is displayed only when the value of the SourceType parameter is VERSION.
VersionId	string	The version number.	e179bbb8163dcdcfacda24858bedb4d8006ae2b8
TableInfoList	array<object>	The tables included in the schema synchronization.
	object	A table entry in the schema synchronization.
SourceTableName	string	The name of the source table.	test_tbl
TargetTableName	string	The name of the destination table.	test_tbl
IgnoreError	boolean	Whether to skip errors during execution. Valid values: true: skips the error and continues to execute SQL statements. false: stops executing SQL statements.	false

Examples

Success response

JSON format

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "StructSyncOrderDetail": {
    "SourceDatabaseInfo": {
      "DbId": 432532,
      "SearchName": "test",
      "DbType": "MySQL",
      "EnvType": "dev",
      "Logic": false
    },
    "TargetDatabaseInfo": {
      "DbId": 432543,
      "SearchName": "test",
      "DbType": "MySQL",
      "EnvType": "dev",
      "Logic": false
    },
    "SourceType": "VERSION",
    "SourceVersionInfo": {
      "VersionId": "e179bbb8163dcdcfacda24858bedb4d8006ae2b8"
    },
    "TargetType": "DATASOURCE",
    "TargetVersionInfo": {
      "VersionId": "e179bbb8163dcdcfacda24858bedb4d8006ae2b8"
    },
    "TableInfoList": [
      {
        "SourceTableName": "test_tbl",
        "TargetTableName": "test_tbl"
      }
    ],
    "IgnoreError": false
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.