调用CreateStructSyncOrder创建结构同步工单。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Comment String 是 test

工单备注。
RelatedUserList Array of Long 否 432435

相关人ID。
Param Object 是

工单参数。
Source Object 是

基准库信息。
DbId Long 是 4324532

库ID，可调用SearchDatabases接口获取。

DbSearchName String 是 test

库搜索名，可调用SearchDatabases接口获取。

Logic Boolean 否 false

是否为逻辑库，取值：

  • true：是
  • false：否
VersionId String 否 e179bbb8163dcdcfacda24858bedb4d8006ae2b8

版本号，默认为最新的表结构版本，更多信息，请参见管理表结构版本。

Target Object 是

目标库信息。
DbId Long 是 432432

库ID，可调用SearchDatabases接口获取。

DbSearchName String 是 test

库搜索名，可调用SearchDatabases接口获取。

Logic Boolean 否 false

是否为逻辑库，取值：

  • true：是
  • false：否
VersionId String 否 e179bbb8163dcdcfacda24858bedb4d8006ae2b8

版本号（默认不填）。

说明 当您输入目标库的表结构版本号时，该工单仅会对比两个库之间的表结构。
IgnoreError Boolean 否 false

是否忽略报错，取值：

  • true：忽略，遇到错误会跳过当前失败SQL脚本，继续执行。
  • false：不忽略，遇到出错则中断后面的SQL脚本，不再执行。
TableInfoList Array 否

同步的表信息列表。
SourceTableName String 否 test_tbl

源表表名。
TargetTableName String 否 test_tbl

目标表表名。
AttachmentKey String 否 upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql

上传附件成功后返回的附件Key，您可以调用GetUserUploadFileJob接口获取。

Tid Long 否 1

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息，详情请参见查看租户信息。
RegionId String 否 cn-hangzhou

选择DMS的服务地域，用于调用该接口，取值请参见RegionID参数说明。

说明 请根据应用所在地就近选择。

返回数据

名称 类型 示例值 描述
RequestId String 4E1D2B4D-3E53-4ABC-999D-1D2520B3471A

请求ID。
Success Boolean true

请求是否成功。
ErrorMessage String UnknownError

错误信息。
ErrorCode String UnknownError

错误码。
CreateOrderResult Array of Long 4325353

工单号。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Comment=test
&RelatedUserList=[432435]
&Param={"Source":{"DbId":4324532,"DbSearchName":"test","Logic":false,"VersionId":"e179bbb8163dcdcfacda24858bedb4d8006ae2b8"},"Target":{"DbId":432432,"DbSearchName":"test","Logic":false,"VersionId":"e179bbb8163dcdcfacda24858bedb4d8006ae2b8"},"SyncType":"STRUCT_TABLES","IgnoreError":false,"TableInfoList":[{"SourceTableName":"test_tbl","TargetTableName":"test_tbl"}]}
&AttachmentKey=-1
&Tid=1
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateStructSyncOrderResponse>
    <CreateOrderResult>2000000</CreateOrderResult>
    <RequestId>0DF19315-DCAF-4376-8006-1CEB0BBC6B13</RequestId>
    <Success>true</Success>
</CreateStructSyncOrderResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "CreateOrderResult" : [ 2000000 ],
  "RequestId" : "0DF19315-DCAF-4376-8006-1CEB0BBC6B13",
  "Success" : true
}

错误码

访问错误中心查看更多错误码。