全部产品
Search
文档中心

数据管理 DMS:CreateDataCorrectOrder - 创建普通数据变更工单

更新时间:Aug 28, 2026

创建普通数据变更工单。

接口说明

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

关于该功能的更多说明,请参见普通数据变更

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:CreateDataCorrectOrder

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Comment

string

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

test

RelatedUserList

array

相关人列表。

integer

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

51****

Param

object

工单参数。

Classify

string

数据变更原因。

test

EstimateAffectRows

integer

预估本次变更会影响的数据行数。

1

ExecSQL

string

变更 SQL 语句。

说明
  • 如果 SqlTypeTEXT,该参数必填。

  • SQL 代码大小不能超过 1 KB。

update base_user set id = 1 where id = 1;

SqlType

string

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

  • TEXT:文本。

  • ATTACHMENT:附件。

说明

如果您选择文本方式,则 SQL 代码大小不能超过 1 KB。如果 SQL 代码超过 1 KB,建议您选择上传附件的方式。

TEXT

AttachmentName

string

变更 SQL 附件 Key(AttachmentKey),可通过调用 GetUserUploadFileJob 接口获取该参数的值。

说明

如果 SqlTypeATTACHMENT,该参数必填。

test.sql

RollbackSQL

string

回滚 SQL 语句。

说明

如果 RollbackSqlTypeTEXT,该参数必填。

update base_user set id = 1 where id = 1;

RollbackAttachmentName

string

回滚 SQL 附件 Key(AttachmentKey),可通过调用 GetUserUploadFileJob 接口获取该参数的值。

说明

如果 RollbackSqlTypeATTACHMENT,该参数必填。

test_rollback.sql

RollbackSqlType

string

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

  • TEXT:文本

  • ATTACHMENT:附件

TEXT

DbItemList

array<object>

变更的数据库或实例列表。

object

当变更对象为数据库时,请填写 DbId 参数;当变更对象为实例时,请填写 InstanceId 参数。

说明

DbId 和 InstanceId 参数只能二选一填写。如果二者均填写,则默认只对数据库进行变更处理,忽略 InstanceId 参数。

DbId

integer

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

1860****

Logic

boolean

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

  • true:逻辑库

  • false:物理库

false

InstanceId

integer

实例 ID。您可调用 ListInstancesGetInstance 接口获取该参数的值。

说明

目前实例的变更仅支持选择如下类型的 MySQL 实例:RDS MySQL、PolarDB MySQL 版和 AnalyticDB for MySQL。

1860****

ExecMode

string

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

  • COMMITOR : 审批通过后,提交者执行。

  • AUTO : 审批通过后,自动执行。

  • LAST_AUDITOR : 审批通过后,最后一个审批人执行。

COMMITOR

AttachmentKey

string

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

order_attachment.txt

RealLoginUserUid

string

实际调用 API 的用户的阿里云账号 UID。

21400447956867****

Tid

integer

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

3***

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931

Success

boolean

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

  • true:请求成功

  • false:请求失败

true

ErrorMessage

string

错误信息。

UnknownError

ErrorCode

string

错误码。

UnknownError

CreateOrderResult

array

工单创建结果。

integer

普通数据变更工单号。

142****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情