All Products
Search

This Product

    Data Management:CreateStructSyncOrder

    Document Center

    Data Management:CreateStructSyncOrder

    Last Updated:Aug 27, 2026

    Creates a schema synchronization ticket.

    Operation description

    Available only for database instances in Security Collaboration control mode.

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

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Comment

    string

    Yes

    Ticket remarks.

    test
    RelatedUserList

    array

    No

    Stakeholder IDs.

    integer

    No

    Stakeholder ID.

    432***
    Param

    object

    Yes

    Ticket parameters.

    Source

    object

    Yes

    Base database information.

    DbId

    integer

    Yes

    Database ID. Call SearchDatabases to query this value.

    432****
    DbSearchName

    string

    Yes

    Database search name. Call SearchDatabases to query this value.

    test
    Logic

    boolean

    No

    Whether this is a logical database. Valid values:

    • true: Logical database.

    • false: Not a logical database.

    false
    VersionId

    string

    No

    Schema version number. Defaults to the latest version. Manage schema versions.

    e179bbb8163dcdcfacda24858bedb4d8006ae2b8
    Target

    object

    Yes

    Target database for schema synchronization.

    DbId

    integer

    Yes

    Database ID. Call SearchDatabases to query this value.

    432***
    DbSearchName

    string

    Yes

    Database search name. Call SearchDatabases to query this value.

    test
    Logic

    boolean

    No

    Whether this is a logical database. Valid values:

    • true: Logical database.

    • false: Not a logical database.

    false
    VersionId

    string

    No

    Schema version number. Empty by default.

    Note

    If specified, DMS only compares schemas between the two databases.

    e179bbb8163dcdcfacda24858bedb4d8006ae2b8
    IgnoreError

    boolean

    No

    Whether to skip errors during SQL execution. Valid values:

    • true: Continues executing subsequent SQL statements on error.

    • false: Stops executing subsequent SQL statements on error.

    false
    TableInfoList

    array<object>

    No

    Tables for schema synchronization.

    object

    No

    Table for schema synchronization.

    SourceTableName

    string

    No

    The name of the source table.

    test_tbl
    TargetTableName

    string

    No

    The name of the destination table.

    test_tbl
    AttachmentKey

    string

    No

    Attachment key returned after upload. Call GetUserUploadFileJob to query this value.

    upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql
    Tid

    integer

    No

    The ID of the tenant.

    Note

    To find the tenant ID, hover over the profile icon in the upper-right corner of the DMS console. Manage DMS tenants.

    3***

    Response elements

    Element

    Type

    Description

    Example

    object

    The schema of the response.

    RequestId

    string

    Request ID.

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

    boolean

    Whether the request succeeded.

    true
    ErrorMessage

    string

    The error message.

    UnknownError
    ErrorCode

    string

    The error code.

    UnknownError
    CreateOrderResult

    array

    Ticket creation result.

    integer

    Ticket ID.

    432****

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.