All Products
Search
Document Center

Data Management:CreateStructSyncOrder

Last Updated:Apr 26, 2024

Creates a schema synchronization ticket.

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

Request parameters

ParameterTypeRequiredDescriptionExample
CommentstringYes

The remarks of the ticket.

test
RelatedUserListarrayNo

The IDs of the stakeholders.

longNo

The ID of a stakeholder.

432435
ParamobjectYes

The parameters of the ticket.

SourceobjectYes

The information about the base database.

DbIdlongYes

The ID of the database. You can call the SearchDatabases operation to query the ID of the database.

4324532
DbSearchNamestringYes

The name that is used to search for the database. You can call the SearchDatabases operation to query the name of the database.

test
LogicbooleanNo

Specifies 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
VersionIdstringNo

The version number of the schema. The default value is the latest schema version number. For more information, see Manage schema versions.

e179bbb8163dcdcfacda24858bedb4d8006ae2b8
TargetobjectYes

The information about the database to which you want to synchronize the schema of a table.

DbIdlongYes

The ID of the database. You can call the SearchDatabases operation to query the ID of the database.

432432
DbSearchNamestringYes

The name that is used to search for the database. You can call the SearchDatabases operation to query the name of the database.

test
LogicbooleanNo

Specifies 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
VersionIdstringNo

The version number. By default, this parameter is left empty.

Note If you specify the schema version number of the destination database, Data Management (DMS) only compares the schemas of the two databases.
e179bbb8163dcdcfacda24858bedb4d8006ae2b8
IgnoreErrorbooleanNo

Specifies whether to skip an error that occurs in executing an SQL statement. Valid values:

  • true: continues to execute subsequent SQL statements if an error occurs in executing an SQL statement.
  • false: stops executing subsequent SQL statements if an error occurs in executing an SQL statement.
false
TableInfoListobject []No

The information about the table of which you want to synchronize the schema.

SourceTableNamestringNo

The name of the source table.

test_tbl
TargetTableNamestringNo

The name of the destination table.

test_tbl
AttachmentKeystringNo

The key of an attachment that is returned after the attachment is uploaded. You can call the GetUserUploadFileJob operation to query the key of the attachment.

upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql
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 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 is successful.

true
ErrorMessagestring

The error message.

UnknownError
ErrorCodestring

The error code.

UnknownError
CreateOrderResultarray

The result of creating the ticket.

long

The ID of the ticket.

4325353

Examples

Sample success responses

JSONformat

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "CreateOrderResult": [
    4325353
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history