文档

CreateDataCorrectOrder - 创建普通数据变更工单

创建普通数据变更工单。

接口说明

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

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

调试

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

授权信息

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

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

请求参数

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

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

test
RelatedUserListarray

相关人列表。

long

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

51****
Paramobject

工单参数。

Classifystring

数据变更原因。

test
EstimateAffectRowslong

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

1
ExecSQLstring

变更 SQL 语句。

说明 如果 SqlTypeTEXT,该参数必填。
update base_user set id = 1 where id = 1;
SqlTypestring

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

  • TEXT:文本
  • ATTACHMENT:附件
TEXT
AttachmentNamestring

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

说明 如果 SqlTypeATTACHMENT,该参数必填。
test.sql
RollbackSQLstring

回滚 SQL 语句。

说明
  • 如果 RollbackSqlTypeTEXT,该参数必填。
  • update base_user set id = 1 where id = 1;
    RollbackAttachmentNamestring

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

    说明 如果 RollbackSqlTypeATTACHMENT,该参数必填。
    test_rollback.sql
    RollbackSqlTypestring

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

    • TEXT:文本
    • ATTACHMENT:附件
    TEXT
    DbItemListobject []

    变更的数据库列表。

    DbIdlong

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

    1860****
    Logicboolean

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

    • true:逻辑库
    • false:物理库
    false
    ExecModestring

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

    • COMMITOR : 审批通过后,提交者执行。
    • AUTO : 审批通过后,自动执行。
    • LAST_AUDITOR : 审批通过后,最后一个审批人执行。
    COMMITOR
    AttachmentKeystring

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

    order_attachment.txt
    Tidlong

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

    3***

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 ID。

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

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

    • true:请求成功
    • false:请求失败
    true
    ErrorMessagestring

    错误信息。

    UnknownError
    ErrorCodestring

    错误码。

    UnknownError
    CreateOrderResultarray

    工单创建结果。

    long

    普通数据变更工单号。

    142****

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)