全部产品
Search
文档中心

数据管理 DMS:CreateStructSyncOrder - 创建结构同步工单

更新时间:Mar 17, 2023

创建变更工单。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:CreateStructSyncOrderRead
    全部资源

请求参数

名称类型必填描述示例值
Commentstring

工单备注。

test
RelatedUserListarray

相关人ID列表。

long

相关人ID。

432435
Paramobject

工单参数。

Sourceobject

基准库信息。

DbIdlong

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

4324532
DbSearchNamestring

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

test
Logicboolean

是否为逻辑库,取值:

  • true:是
  • false:否
false
VersionIdstring

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

e179bbb8163dcdcfacda24858bedb4d8006ae2b8
Targetobject

目标库信息。

DbIdlong

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

432432
DbSearchNamestring

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

test
Logicboolean

是否为逻辑库,取值:

  • true:是
  • false:否
false
VersionIdstring

版本号(默认不填)。

说明当您输入目标库的表结构版本号时,该工单仅会对比两个库之间的表结构。
e179bbb8163dcdcfacda24858bedb4d8006ae2b8
IgnoreErrorboolean

是否忽略报错,取值:

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

同步的表信息列表。

object

同步的表。

SourceTableNamestring

源表表名。

test_tbl
TargetTableNamestring

目标表表名。

test_tbl
AttachmentKeystring

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

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

租户ID。

说明取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息
1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

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

请求是否成功。

true
ErrorMessagestring

错误信息。

UnknownError
ErrorCodestring

错误码。

UnknownError
CreateOrderResultarray

创建工单结果。

long

工单号。

4325353

示例

正常返回示例

JSON格式

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

错误码

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