调用CreateFreeLockCorrectOrder创建无锁变更工单。

关于无锁变更的更多信息,请参见无锁变更概览

目前仅支持管控模式为稳定变更、安全协同的实例调用该API,更多信息,请参见无锁数据变更无锁结构变更

调试

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

请求参数

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

业务背景,以减少沟通成本。

RelatedUserList Array of Long 431532

相关人ID,设置的相关人员可查看工单,并协同工作,非相关人员则不能查看工单(管理员、DBA除外)。

Param Object

工单参数。

Classify String test

数据变更原因。

ExecSQL String delete from base_user where 1 = 1;

变更SQL语句。

说明SqlType参数为 TEXT时,该参数必填。
SqlType String TEXT

变更SQL的提交方式,取值:

  • TEXT:文本
  • ATTACHMENT:附件
    说明 目前仅支持 TEXT格式。
AttachmentName String test.sql

变更SQL附件key,您可以调用GetUserUploadFileJob接口获取该参数(该参数为GetUserUploadFileJob接口中的AttachmentKey参数)。

说明SqlType参数为 ATTACHMENT时,该参数必填。
RollbackSQL String empty

回滚SQL语句。

说明 > 当 RollbackSqlType参数为 TEXT时,该参数必填。
RollbackAttachmentName String test_rollback.sql

回滚SQL附件key,您可以调用GetUserUploadFileJob接口获取该参数(该参数为GetUserUploadFileJob接口中的AttachmentKey参数)。

说明RollbackSqlType参数为 ATTACHMENT时,该参数必填。
RollbackSqlType String TEXT

回滚SQL的提交方式,取值:

  • TEXT:文本
  • ATTACHMENT:附件
DbItemList Array

变更的数据库列表。

DbId Long 432153

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

Logic Boolean false

是否为逻辑库,取值:

  • true:是
  • false:否
AttachmentKey String order_attachment.txt

工单补充附件,对本次操作进行补充说明。

您可以调用GetUserUploadFileJob接口获取该参数。

Tid Long 14325

租户ID。

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

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

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

返回数据

名称 类型 示例值 描述
RequestId String 0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

CreateOrderResult Array of Long 1342353

工单号。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Comment=test
&RelatedUserList=[431532]
&Param={"Classify":"test","ExecSQL":"delete from base_user where 1 = 1;","SqlType":"TEXT","AttachmentName":"test.sql","RollbackSQL":"empty","RollbackAttachmentName":"test_rollback.sql","RollbackSqlType":"TEXT","DbItemList":[{"DbId":432153,"Logic":false}]}
&AttachmentKey=order_attachment.txt
&Tid=14325
&公共请求参数

正常返回示例

XML格式

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

<CreateFreeLockCorrectOrderResponse>
    <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>
    <Success>true</Success>
    <CreateOrderResult>1342353</CreateOrderResult>
</CreateFreeLockCorrectOrderResponse>

JSON格式

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

{
  "RequestId" : "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success" : true,
  "CreateOrderResult" : [ 1342353 ]
}

错误码

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