調用CreateDataImportOrder建立資料匯入工單-Data Management-阿里雲

建立資料匯入工單。

介面說明

僅管控模式為安全協同的資料庫執行個體可調用此 API。

關於該功能的更多說明，請參見資料匯入。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:CreateDataImportOrder

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Comment	string	是	資料匯入的業務背景，以減少溝通成本。	test
RelatedUserList	array	否	相關人列表。
	integer	否	變更相關人的使用者識別碼，設定的相關人員可查看工單，並協同工作，非相關人員則不能查看工單（管理員、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
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。