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

创建变更工单。

接口说明

仅管控模式为安全协同的数据库实例可调用此 API。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:CreateStructSyncOrder

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Comment	string	是	工单备注。	test
RelatedUserList	array	否	相关人 ID 列表。
	integer	否	相关人 ID。	432***
Param	object	是	工单参数。
Source	object	是	基准库信息。
DbId	integer	是	库 ID，可调用 SearchDatabases 接口获取。	432****
DbSearchName	string	是	库搜索名，可调用 SearchDatabases 接口获取。	test
Logic	boolean	否	是否为逻辑库，取值： true：是 false：否	false
VersionId	string	否	版本号，默认为最新的表结构版本，更多信息，请参见管理表结构版本。	e179bbb8163dcdcfacda24858bedb4d8006ae2b8
Target	object	是	目标库信息。
DbId	integer	是	库 ID，可调用 SearchDatabases 接口获取。	432***
DbSearchName	string	是	库搜索名，可调用 SearchDatabases 接口获取。	test
Logic	boolean	否	是否为逻辑库，取值： true：是 false：否	false
VersionId	string	否	版本号。说明当您输入目标库的表结构版本号时，该工单仅会对比两个库之间的表结构。	e179bbb8163dcdcfacda24858bedb4d8006ae2b8
IgnoreError	boolean	否	是否忽略报错，取值： true：忽略，遇到错误会跳过当前失败 SQL 脚本，继续执行。 false：不忽略，遇到出错则中断后面的 SQL 脚本，不再执行。	false
TableInfoList	array<object>	否	同步的表信息列表。
	object	否	同步的表。
SourceTableName	string	否	源表表名。	test_tbl
TargetTableName	string	否	目标表表名。	test_tbl
AttachmentKey	string	否	上传附件成功后返回的附件 Key，您可以调用 GetUserUploadFileJob 接口获取。	upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql
Tid	integer	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	3***

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Success	boolean	请求是否成功。	true
ErrorMessage	string	错误信息。	UnknownError
ErrorCode	string	错误码。	UnknownError
CreateOrderResult	array	创建工单结果。
	integer	工单号。	432****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。