CreateDataImportOrder - 创建数据导入工单 - 数据管理 DMS

创建数据导入工单。

接口说明

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

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:CreateDataImportOrder

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Comment	string	是	数据导入的业务背景，以减少沟通成本。	test
RelatedUserList	array	否	相关人列表。
	integer	否	变更相关人的用户 ID，设置的相关人员可查看工单，并协同工作，非相关人员则不能查看工单（管理员、DBA 除外）。	51****
Param	object	是	工单参数。
Classify	string	否	数据导入原因。	test
AttachmentName	string	是	导入数据的附件 Key（AttachmentKey），可通过调用接口 GetUserUploadFileJob 获取该参数的值。	upload_big_file_test_orders
DbItemList	array<object>	是	待导入的数据库列表，当前仅支持导入一个库。
	object	否	数据库信息。
DbId	integer	是	数据库 ID（DatabaseId），数据库分为物理库和逻辑库两种：物理库 ID：可通过调用接口 ListDatabases 或 SearchDatabase 获取该参数的值。逻辑库 ID：可通过调用接口 ListLogicDatabases 或 SearchDatabase 获取该参数的值。	1860****
Logic	boolean	是	是否为逻辑库，取值如下： true：逻辑库 false：物理库说明如果取值为 true，目标数据库必须为逻辑库。	false
FileType	string	是	文件类型，取值如下： SQL：SQL 文件。 CSV：CSV 文件。 EXCEL：EXCEL 文件。 JSON：JSON 文件。仅部分数据库支持选择 JSON，例如 MongoDB。枚举值： EXCEL : EXCEL CSV : CSV JSON : JSON SQL : SQL	CSV
FileEncoding	string	否	文件编码，取值如下： AUTO：自动识别 UTF-8：UTF8 编码 GBK：GBK 编码 ISO-8859-1：ISO-8859-1 编码	AUTO
TableName	string	否	选择 CSV 格式文件导入数据的目标表。说明如果 FileType 为 CSV，该参数必填。	Table_text
InsertType	string	否	插入类型，取值如下： INSERT：插入数据时数据库会检查主键（PrimaryKey），如果出现重复会报错。 INSERT_IGNORE：如果表中已经存在相同的记录，则忽略当前新数据。 REPLACE_INTO：如果表中已经有某行数据（根据主键或者唯一索引判断），则先删除此行数据，然后插入新的数据。说明如果 FileType 为 CSV，该参数必填。	INSERT
CsvFirstRowIsColumnDef	boolean	否	CSV 格式的类型，取值如下： true：CSV 表格首行是字段名。 false：CSV 表格首行是数据。说明如果 FileType 为 CSV，该参数必填。	true
IgnoreError	boolean	否	是否忽略报错，取值如下： true：忽略，遇到错误会跳过当前失败 SQL 脚本，继续执行。 false：不忽略，遇到出错则中断后面的 SQL 脚本，不再执行。	false
ImportMode	string	否	导入模式，取值如下： FAST_MODE：极速模式，在执行阶段读取文件，将 SQL 语句直接执行到指定的目标库。该模式安全性相比安全模式要低，但是执行时效较高。 SAFE_MODE：安全模式，在预检查阶段会解析文件并将 SQL 或 CSV 数据缓存入库，执行时再从缓存库中读出来执行到指定的目标库。该模式安全性较好，但是执行时效相比极速模式要低。	FAST_MODE
RollbackSQL	string	否	回滚 SQL 语句。说明如果 RollbackSqlType 为 TEXT，该参数必填。	empty
RollbackAttachmentName	string	否	回滚 SQL 附件 Key（AttachmentKey），可通过调用接口 GetUserUploadFileJob 获取该参数的值。说明如果 RollbackSqlType 为 ATTACHMENT，该参数必填。	rollback.sql
RollbackSqlType	string	否	回滚 SQL 的提交方式，取值如下： TEXT：文本 ATTACHMENT：附件	TEXT
ExecMode	string	否	工单执行方式，取值如下： COMMITOR : 审批通过后，提交者执行。 AUTO : 审批通过后，自动执行。 LAST_AUDITOR : 审批通过后，最后一个审批人执行。	COMMITOR
AttachmentKey	string	否	工单附件 Key，补充当前工单信息。可通过调用接口 GetUserUploadFileJob 获取该参数的值。	order_attachment.txt
Tid	integer	否	租户 ID，可通过调用接口 GetUserActiveTenant 或 ListUserTenants 获取该参数的值。	3***
RealLoginUserUid	string	否	实际调用 API 的用户的阿里云账号 UID。	21400447956867****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
ErrorMessage	string	错误信息。	UnknownError
ErrorCode	string	错误码。	UnknownError
CreateOrderResult	array	工单创建结果。
	integer	工单号。	1****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。