創建數據庫導出工單。
接口說明
僅管控模式為安全協同的數據庫實例可調用此 API。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dms:CreateDatabaseExportOrder | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ParentId | long | 否 | 父工單 ID。 | 877**** |
| Comment | string | 是 | 業務背景，描述提工單的原因，以減少溝通成本。 | 文檔測試 |
| AttachmentKey | string | 否 | 工單附件 Key，補充當前工單信息。可通過調用接口 GetUserUploadFileJob 獲取該參數的值。 | order_attachment.txt |
| PluginParam | object | 是 | 工單參數。 | |
| Classify | string | 是 | 導出原因。 | 文檔測試 |
| DbId | long | 是 | 數據庫 ID。您可通過調用 GetDatabase 獲取該參數的值。 | 17**** |
| InstanceId | long | 是 | 實例 ID。您可通過調用 GetInstance 接口獲取該參數的值。 | 137**** |
| Logic | boolean | 是 | 是否為邏輯庫，取值如下：
| false |
| Config | object | 是 | 導出配置。 | |
| SQLExtOption | array | 是 | SQL 腳本拓展選項。列表長度可為 0。 | |
| string | 否 | 選項列表：
| DROP | |
| DataOption | array | 是 | 大數據導出選項，用于篩選需要導出哪些大數據類型。列表長度可為 0。 | |
| string | 否 | 導出選項：
| BLOB | |
| ExportContent | string | 是 | 導出內容。取值如下：
| DATA |
| ExportTypes | array | 否 | 導出結構類型。 | |
| string | 否 | 取值如下（可多選）：
| PROCEDURE | |
| SelectedTables | array | 否 | 導出的表列表。 | |
| string | 否 | 選中導出哪些表。 | dmstest_table | |
| Tables | object | 否 | 導出表過濾條件。 | |
| string | 否 | 過濾條件。 | where 1=1 | |
| TargetOption | string | 是 | 導出格式。取值如下：
| SQL |
| SearchName | string | 是 | 數據庫搜索名稱。 | test@xxx.xxx.xxx.xxx:3306 |
| RelatedUserList | array | 否 | 相關人列表。 | |
| long | 否 | 變更相關人的用戶 ID。設置的相關人員可查看工單，并協同工作，非相關人員則不能查看工單（管理員、DBA 除外）。 | 2452345113**** | |
| Tid | long | 否 | 租戶 ID。 說明
取自系統右上角頭像處懸停展示的租戶 ID 信息，詳情請參見查看租戶信息。
| 3*** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"CreateOrderResult": {
"CreateOrderResult": [
0
]
},
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史