调用CreateDataImportOrder创建数据导入工单。

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

调试

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

请求参数

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

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

Comment String test

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

RelatedUserList Array of Long 24325

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

Param Object

工单参数。

Classify String test

数据导入原因。

AttachmentName String test

导入数据的附件key,您可以调用GetUserUploadFileJob接口获取该参数(该参数为GetUserUploadFileJob接口中的AttachmentKey参数)。

DbItemList Array

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

DbId Long 1342353

数据库ID,可调用SearchDatabases接口获取。

Logic Boolean false

是否为逻辑库,取值:

  • true:是
  • false:否
FileType String CSV

文件类型,取值:

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

文件编码,取值和说明如下:

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

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

说明FileType参数为CSV时,该参数必填。
InsertType String INSERT

插入类型,取值:

  • INSERT
  • INSERT_IGNORE
  • REPLACE_INTO
说明FileType参数为CSV时,该参数必填。
CsvFirstRowIsColumnDef Boolean true

CSV格式的类型,取值:

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

是否忽略报错,取值:

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

导入模式,取值:

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

回滚SQL语句。

说明 > 当RollbackSqlType参数为TEXT时,该参数必填。
RollbackAttachmentName String rollback.sql

回滚SQL附件key,您可以调用GetUserUploadFileJob接口获取该参数(该参数为GetUserUploadFileJob接口中的AttachmentKey参数)。

说明RollbackSqlType参数为ATTACHMENT时,该参数必填。
RollbackSqlType String TEXT

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

  • TEXT:文本
  • ATTACHMENT:附件
AttachmentKey String order_attachment.txt

工单补充附件,对本次操作进行补充说明。

您可以调用GetUserUploadFileJob接口获取该参数。

Tid Long 14325432

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息
RegionId String cn-hangzhou

选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明

说明 请根据应用所在地就近选择。

返回数据

名称 类型 示例值 描述
RequestId String 0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

CreateOrderResult Array of Long 13453

工单号。

示例

请求示例

http(s)://[Endpoint]/?Comment=test
&RelatedUserList=[24325]
&Param={"Classify":"test","AttachmentName":"test.csv","DbItemList":[{"DbId":1342353,"Logic":false}],"FileType":"CSV","FileEncoding":"AUTO","TableName":"t1","InsertType":"INSERT","CsvFirstRowIsColumnDef":true,"IgnoreError":false,"ImportMode":"FAST_MODE","RollbackSQL":"empty","RollbackAttachmentName":"rollback.sql","RollbackSqlType":"TEXT"}
&AttachmentKey=order_attachment.txt
&Tid=14325432
&公共请求参数

正常返回示例

XML格式

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

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

JSON格式

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

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

错误码

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