调用CreateDataImportOrder接口,在DMS中创建数据导入工单。

关于该功能的更多说明,请参见数据导入

调试

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

请求参数

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

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

Comment String test

数据导入的业务背景,以减少沟通成本。

RelatedUserList Array of Long 51****

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

Param Object

工单参数。

Classify String test

数据导入原因。

AttachmentName String order_text

导入数据的附件Key(AttachmentKey),可通过调用接口GetUserUploadFileJob获取该参数的值。

DbItemList Array

待导入的数据库列表,当前仅支持导入一个库。

DbId Long 1860****

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

Logic Boolean false

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

  • true:逻辑库
  • false:物理库
说明 如果取值为true,目标数据库必须为逻辑库。
FileType String CSV

文件类型,取值如下:

  • SQL:SQL文件
  • CSV:CSV文件
FileEncoding String AUTO

文件编码,取值如下:

  • AUTO:自动识别
  • UTF-8:UTF8编码
  • GBK:GBK编码
  • ISO-8859-1:ISO-8859-1编码
TableName String Table_text

选择CSV格式文件导入数据的目标表。

说明 如果FileTypeCSV,该参数必填。
InsertType String INSERT

插入类型,取值如下:

  • INSERT:插入数据时数据库会检查主键(PrimaryKey),如果出现重复会报错。
  • INSERT_IGNORE:如果表中已经存在相同的记录,则忽略当前新数据。
  • REPLACE_INTO:如果表中已经有某行数据(根据主键或者唯一索引判断),则先删除此行数据,然后插入新的数据。
说明 如果FileTypeCSV,该参数必填。
CsvFirstRowIsColumnDef Boolean true

CSV格式的类型,取值如下:

  • true:CSV表格首行是字段名。
  • false:CSV表格首行是数据。
说明 如果FileTypeCSV,该参数必填。
IgnoreError Boolean false

是否忽略报错,取值如下:

  • true:忽略,遇到错误会跳过当前失败SQL脚本,继续执行。
  • false:不忽略,遇到出错则中断后面的SQL脚本,不再执行。
ImportMode String FAST_MODE

导入模式,取值如下:

  • FAST_MODE:极速模式,在执行阶段读取文件,将SQL语句直接执行到指定的目标库。该模式安全性相比安全模式要低,但是执行时效较高。
  • SAFE_MODE:安全模式,在预检查阶段会解析文件并将SQL或CSV数据缓存入库,执行时再从缓存库中读出来执行到指定的目标库。该模式安全性较好,但是执行时效相比极速模式要低。
RollbackSQL String empty

回滚SQL语句。

说明 如果RollbackSqlTypeTEXT,该参数必填。
RollbackAttachmentName String rollback.sql

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

说明 如果RollbackSqlTypeATTACHMENT,该参数必填。
RollbackSqlType String TEXT

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

  • TEXT:文本
  • ATTACHMENT:附件
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 1****

工单号。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=test
&Comment=test
&RelatedUserList=[51****]
&Param={"Classify":"test","AttachmentName":"order_text","DbItemList":[{"DbId":1860****,"Logic":false}],"FileType":"CSV","FileEncoding":"AUTO","TableName":"Table_text","InsertType":"INSERT","CsvFirstRowIsColumnDef":true,"IgnoreError":false,"ImportMode":"FAST_MODE"}
&AttachmentKey=order_attachment.txt
&公共请求参数

正常返回示例

XML格式

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

<CreateDataImportOrderResponse>
    <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>
    <Success>true</Success>
    <CreateOrderResult>1****</CreateOrderResult>
</CreateDataImportOrderResponse>

JSON格式

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

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

错误码

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