调用CreateOrder创建工单。

调试

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

请求参数

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

系统规定参数。取值:CreateOrder

Tid Long 3***

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

Comment String test

创建工单描述信息。

PluginParam Map {PluginParam_test}

创建工单参数,格式为JSON形式的字符串,每个工单类型的参数设置不一致,详情请参见补充说明。

RelatedUserList String user1,user2

工单相关人ID列表,多个相关人用逗号(,)隔开。

PluginType String DATA_EXPORT

工单类型,取值说明如下:

  • DC_COMMON:普通数据变更
  • DC_CHUNK:无锁数据变更
  • DC_CRON_CLEAR:历史数据清理
  • NDDL:结构设计
  • DATA_EXPORT:数据导出
  • PERM_APPLY:权限申请
  • OWNER_APPLY:Owner申请
RegionId String cn-hangzhou

DMS服务地域,请您根据应用所在地就近选择。取值请参见RegionID参数说明

AttachmentKey String test_AttachmentKey

上传附件成功后返回的附件Key,您可以通过调用接口GetUserUploadFileJob获取该参数的值。

PluginParam参数补充说明


json

# 普通数据变更
 {
    "classify" : "测试", // 原因分类
    "estimateAffectRows" : 1, // 用户预估影响行数
    "execSQL" : "update base_op_log set id=1 where id=1;", // 执行SQL
    "dbItemList" : [ { // 执行的db列表
      "dbId" : 17****,
      "logic" : false
    } ],
    "rbSQL" : "update base_op_log set id=1 where id=1;", // 用户填写的回滚SQL
    "rbAttachmentName" : null, // 回滚SQL附件
    "sqlType" : "TEXT", // SQL类型,取值为TEXT, ATTACHMENT
    "rbSQLType" : "TEXT", // 回滚SQL类型,取值同上
    "attachmentName" : // SQL附件,您可以调用GetUserUploadFileJob接口获取附件Key。
  }


# 无锁数据变更
 {
    "classify" : "测试",
    "execSQL" : "update base_op_log set op_type=op_type where 1=1;", // 执行SQL
    "dbItemList" : [ { 
      "dbId" : 17****, // 变更库id
      "logic" : false
    } ]
  }

# 历史数据清理
 {
    "duration" : 10, // 指定时长(小时),当不指定时长时,值为0;
    "specifyDuration" : true, // 是否指定时长,true:是,false:否,默认是false
    "classify" : "测试",
    "cronFormat" : "0 1 21 * * ?", // 定时执行的表达式
    "execSql" : null,
    "dbItemList" : [ {
      "dbId" : 17****, // 变更库id
      "logic" : false
    } ],
    "cronClearItemList" : [ {
      "filterSQL" : null, // 过滤条件
      "columnName" : "gmt_create", // 时间字段
      "remainDays" : 60, // 保留时长
      "tableName" : "base_app" // 表名
    } ]
  }

json
# 结构设计
 {
    "title": "test", // 标题
    "description": "test", // 描述
    "dbId": 11****, // 基准库
    "logic": false, // 是否逻辑库
    "relatedIds": [], // 变更相关人id
  }
json

# 数据导出
 {
  "classify": "原因分类", // 原因分类
  "dbId": 17****, // 导出库id
  "exeSQL": "select 1", // 导出SQL
  "logic": false, // 是否逻辑库
  "ignoreAffectRows": false, // 是否忽略校验影响行数
  "affectRows": 1, // 用户预估影响行数
  "ignoreAffectRowsReason": "" // 忽略影响行数校验原因
 }

返回数据

名称 类型 示例值 描述
CreateOrderResult Array of Long 12***

创建工单成功后返回的工单号。

RequestId String 427688B8-ADFB-4C4E-9D45-EF5C1FD6****

请求ID。

ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

Success Boolean true

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

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

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=CreateOrder
&Comment=test
&PluginParam={PluginParam_test}
&PluginType=DATA_EXPORT
&RelatedUserList=user1,user2
&<公共请求参数>

正常返回示例

JSON格式

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

{
  "RequestId" : "427688B8-ADFB-4C4E-9D45-EF5C1FD6****",
  "CreateOrderResult" : {
    "OrderIds" : "12***"
  },
  "Success" : true
}

错误码

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