全部產品
Search

搜尋本產品

    Data Management：CreateDatabaseExportOrder - 建立資料庫匯出工單

    文件中心

    Data Management：CreateDatabaseExportOrder - 建立資料庫匯出工單

    更新時間：Mar 21, 2026

    建立資料庫匯出工單。

    介面說明

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

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dms:CreateDatabaseExportOrder

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ParentId

    integer

    否

    父工單 ID。

    877****
    Comment

    string

    是

    業務背景，描述提工單的原因，以減少溝通成本。

    文檔測試
    AttachmentKey

    string

    否

    工單附件 Key，補充當前工單資訊。可通過調用介面 GetUserUploadFileJob 擷取該參數的值。

    order_attachment.txt
    PluginParam

    object

    是

    工單參數。

    Classify

    string

    是

    匯出原因。

    文檔測試
    DbId

    integer

    是

    資料庫 ID。您可通過調用 GetDatabase 擷取該參數的值。

    17****
    InstanceId

    integer

    是

    執行個體 ID。您可通過調用 GetInstance 介面擷取該參數的值。

    137****
    Logic

    boolean

    是

    是否為邏輯庫，取值如下：

    • true：是

    • false：否

    false
    Config

    object

    是

    匯出配置。

    SQLExtOption

    array

    是

    SQL 指令碼拓展選項。列表長度可為 0。

    string

    否

    選項列表：

    • DROP：在 CREATE 語句前產生 DROP TABLE 語句。

    • TRUNCATE：在 INSERT 語句前產生 TRUNCATE TABLE 語句。

    • COMPRESS：壓縮 INSERT 語句，將 VALUES 合并為 5 M 大小。

    DROP
    DataOption

    array

    是

    巨量資料匯出選項，用於篩選需要匯出哪些巨量資料類型。列表長度可為 0。

    string

    否

    匯出選項：

    • BLOB：匯出 BLOG、TINYBLOB 等類型。

    • TEXT：匯出 TEXT、TNIYTEXT 等類型。

    • BINARY：匯出 BINARY、VARBINARY 等類型。

    BLOB
    ExportContent

    string

    是

    匯出內容。取值如下：

    • DATA：資料。

    • STRUCT：結構。

    • DATA_STRUCT：資料和結構。

    DATA
    ExportTypes

    array

    否

    匯出結構類型。

    string

    否

    取值如下（可多選）：

    • PROCEDURE：預存程序。

    • FUNCTION：函數。

    • TRIGGER：觸發器。

    • VIEW：視圖。

    • EVENT：事件。

    PROCEDURE
    SelectedTables

    array

    否

    匯出的表列表。

    string

    否

    選中匯出哪些表。

    dmstest_table
    Tables

    object

    否

    匯出表過濾條件。

    string

    否

    過濾條件。

    where 1=1
    TargetOption

    string

    是

    匯出格式。取值如下：

    • SQL

    • CSV

    • XLSX

    SQL
    SearchName

    string

    是

    資料庫搜尋名稱。

    test@xxx.xxx.xxx.xxx:3306
    RelatedUserList

    array

    否

    相關人列表。

    integer

    否

    變更相關人的使用者識別碼。設定的相關人員可查看工單，並協同工作，非相關人員則不能查看工單（管理員、DBA 除外）。

    2452345113****
    Tid

    integer

    否

    租戶 ID。

    說明

    取自系統右上方頭像處懸停展示的租戶 ID 資訊，詳情請參見查看租戶資訊。

    3***

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID，用於定位日誌，排查問題。

    0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
    ErrorCode

    string

    錯誤碼。

    UnknownError
    ErrorMessage

    string

    調用失敗時，返回的出錯資訊。

    UnknownError
    CreateOrderResult

    object

    CreateOrderResult

    array

    建立的工單包含的資訊。

    integer

    工單 ID。

    12***
    Success

    boolean

    請求是否成功，傳回值如下：

    • true：請求成功

    • false：請求失敗

    true

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

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

    變更歷史

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