调用CreateOrder接口在DMS创建工单。

为了降低创建工单的难度,如果您需要创建以下类型的工单,请调用专用接口创建。

调试

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

请求参数

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

系统规定参数。取值:CreateOrder

Tid Long 3***

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

Comment String test

输入工单描述信息。

PluginParam Map {PluginParam_test}

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

RelatedUserList String user1,user2

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

PluginType String DATA_EXPORT

工单类型,取值请参见PluginType参数说明

RegionId String cn-hangzhou

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

AttachmentKey String test_AttachmentKey

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

PluginParam参数补充说明


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

# 数据导出
 {
  "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
&<公共请求参数>

正常返回示例

XML格式

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

<CreateOrderResponse>
    <RequestId>427688B8-ADFB-4C4E-9D45-EF5C1FD6****</RequestId>
    <CreateOrderResult>
        <OrderIds>12***</OrderIds>
    </CreateOrderResult>
    <Success>true</Success>
</CreateOrderResponse>

JSON格式

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

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

错误码

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