All Products
Search
Document Center

Data Management:GetStructSyncOrderDetail

Last Updated:Nov 28, 2024

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.

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:GetStructSyncOrderDetailget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

The ID of the ticket.

43****
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.

4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Successboolean

Indicates whether the request was successful.

true
ErrorMessagestring

The error message.

UnknownError
ErrorCodestring

The error code.

UnknownError
StructSyncOrderDetailobject

The details of the schema synchronization ticket.

SourceDatabaseInfoobject

The information about the source database.

DbIdlong

The ID of the source database.

432532
SearchNamestring

The name that is used to search for the database.

test
DbTypestring

The type of the database engine.

MySQL
EnvTypestring

The type of the environment to which the database instance belongs. For more information, see Change the environment type of an instance.

dev
Logicboolean

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
TargetDatabaseInfoobject

The information about the destination database.

DbIdlong

The ID of the destination database.

432543
SearchNamestring

The name that is used to search for the database.

test
DbTypestring

The type of the database engine.

MySQL
EnvTypestring

The type of the environment to which the database instance belongs. For more information, see Change the environment type of an instance.

dev
Logicboolean

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
SourceTypestring

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
SourceVersionInfoobject

The version information about the source instance.

Note This parameter is displayed only when the value of the SourceType parameter is VERSION.
VersionIdstring

The version number.

e179bbb8163dcdcfacda24858bedb4d8006ae2b8
TargetTypestring

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
TargetVersionInfoobject

The version information about the destination instance.

Note This parameter is displayed only when the value of the SourceType parameter is VERSION.
VersionIdstring

The version number.

e179bbb8163dcdcfacda24858bedb4d8006ae2b8
TableInfoListarray<object>

The information about the table whose schema you want to synchronize.

TableInfoobject

The table whose schema you want to synchronize.

SourceTableNamestring

The name of the table whose schema you want to synchronize.

test_tbl
TargetTableNamestring

The name of the table to which you want to synchronize the schema of a table.

test_tbl
IgnoreErrorboolean

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 timeSummary of changesOperation
No change history