调用CreateFreeLockCorrectOrder接口,在DMS中创建无锁变更工单。

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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateFreeLockCorrectOrder

系统规定参数。取值:CreateFreeLockCorrectOrder。

Comment String test

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

RelatedUserList Array of Long 51****

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

Param Object

工单参数。

Classify String test

数据变更原因。

ExecSQL String delete from base_user where 1 = 1;

变更SQL语句。

SqlType String TEXT

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

  • TEXT:文本
  • ATTACHMENT:附件,暂不支持。
AttachmentName String test.sql

变更SQL附件Key,暂不支持该参数。

RollbackSQL String empty

回滚SQL语句。

RollbackAttachmentName String test_rollback.sql

回滚SQL附件Key,暂不支持该参数。

RollbackSqlType String TEXT

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

  • TEXT:文本
  • ATTACHMENT:附件,暂不支持。
DbItemList Array

变更的数据库列表。

DbId Long 1860****

数据库ID(DatabaseId),数据库分为物理库和逻辑库两种:

Logic Boolean false

是否为逻辑库,取值如下:

  • true:逻辑库
  • false:物理库
ExecMode String COMMITOR

工单执行方式,取值如下:

  • COMMITOR : 审批通过后,提交者执行。
  • AUTO : 审批通过后,自动执行。
  • LAST_AUDITOR : 审批通过后,最后一个审批人执行。
AttachmentKey String order_attachment.txt

工单附件Key,补充当前工单信息。可通过调用GetUserUploadFileJob接口获取该参数的值。

Tid Long 3***

租户ID,可通过调用接口GetUserActiveTenantListUserTenants获取该参数的值。

RegionId String cn-hangzhou

DMS服务地域,取值请参见RegionID参数说明

返回数据

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

请求ID。

Success Boolean true

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

CreateOrderResult Array of Long 134****

工单号。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Comment=test
&RelatedUserList=[51****]
&Param={"Classify":"test","ExecSQL":"delete from base_user where 1 = 1;","SqlType":"TEXT","DbItemList":[{"DbId":1860****,"Logic":false}],"ExecMode":"COMMITOR"}
&AttachmentKey=order_attachment.txt
&公共请求参数

正常返回示例

XML格式

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

<CreateFreeLockCorrectOrderResponse>
    <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>
    <Success>true</Success>
    <ErrorMessage>UnknownError</ErrorMessage>
    <ErrorCode>UnknownError</ErrorCode>
    <CreateOrderResult>1340000</CreateOrderResult>
</CreateFreeLockCorrectOrderResponse>

JSON格式

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

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

错误码

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