GetStructSyncOrderDetail - Data Management - Alibaba Cloud Documentation Center

Queries the details of a schema synchronization ticket.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
OrderId	long	Yes	The ID of the ticket.	43****
Tid	long	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 parameters

Parameter	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Success	boolean	Indicates 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 information about the source database.
DbId	long	The ID of the source database.	432532
SearchName	string	The name that is used to search for the database.	test
DbType	string	The type of the database engine.	MySQL
EnvType	string	The type of the environment to which the database instance belongs. For more information, see Change the environment type of an instance.	dev
Logic	boolean	Indicates 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 information about the destination database.
DbId	long	The ID of the destination database.	432543
SearchName	string	The name that is used to search for the database.	test
DbType	string	The type of the database engine.	MySQL
EnvType	string	The type of the environment to which the database instance belongs. For more information, see Change the environment type of an instance.	dev
Logic	boolean	Indicates 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 information about 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 information about 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 information about the table whose schema you want to synchronize.
TableInfo	object	The table whose schema you want to synchronize.
SourceTableName	string	The name of the table whose schema you want to synchronize.	test_tbl
TargetTableName	string	The name of the table to which you want to synchronize the schema of a table.	test_tbl
IgnoreError	boolean	Indicates whether to skip errors. Valid values: true: skips the error and continues to execute SQL statements. false: stops executing SQL statements.	false

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation

No change history