創(chuàng)建SQL結(jié)果集導出工單。
接口說明
僅管控模式為安全協(xié)同的數(shù)據(jù)庫實例可調(diào)用此 API。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| dms:CreateDataExportOrder | create | *全部資源 * |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ParentId | long | 否 | 父工單 ID。 | 877**** |
| Comment | string | 是 | 業(yè)務(wù)背景，描述提工單的原因，以減少溝通成本。 | 業(yè)務(wù)測試。 |
| AttachmentKey | string | 否 | 工單附件 Key，補充當前工單信息。可通過調(diào)用接口 GetUserUploadFileJob 獲取該參數(shù)的值。 | order_attachment.txt |
| RelatedUserList | array | 否 | 相關(guān)人列表。 | |
| long | 否 | 變更相關(guān)人的用戶 ID，非阿里云 UID。設(shè)置的相關(guān)人員可查看工單，并協(xié)同工作，非相關(guān)人員則不能查看工單（管理員、DBA 除外）。 | 2452345113**** | |
| PluginParam | object | 是 | 工單參數(shù)。 | |
| AffectRows | long | 是 | 預(yù)估影響 SQL 行數(shù)。 | 1 |
| Classify | string | 是 | 導出工單的原因類別。 | 測試 |
| InstanceId | long | 是 | 實例 ID。 | 132**** |
| DbId | long | 是 | 數(shù)據(jù)庫 ID。 | 18**** |
| Logic | boolean | 是 | 是否為邏輯庫，取值如下：
說明
如果取值為 true，目標數(shù)據(jù)庫必須為邏輯庫。
| true |
| IgnoreAffectRows | boolean | 是 | 是否跳過 SQL 行數(shù)校驗，返回值如下：
| true |
| IgnoreAffectRowsReason | string | 否 | 跳過 SQL 行數(shù)校驗的原因。當您需要跳過行數(shù)校驗時必須填該參數(shù)。 | 僅測試，不影響業(yè)務(wù)，無需校驗。 |
| ExeSQL | string | 是 | 執(zhí)行的導出 SQL 語句。 | SELECT * FROM DMS_test LIMIT 20; |
| Watermark | object | 否 | 水印相關(guān)信息。 | |
| WatermarkTypes | array | 否 | 水印嵌入類型。 | |
| string | 否 | DATA | ||
| Keys | array | 否 | 主鍵或唯一鍵。 | |
| string | 否 | 主鍵或唯一鍵信息，多個數(shù)據(jù)之間使用英文逗號（,）分割。 | ID | |
| ColumnName | string | 否 | 數(shù)據(jù)水印嵌入字段名稱。 | user_number |
| DataWatermark | string | 否 | 數(shù)據(jù)水印信息。 | 測試 |
| FileWatermark | string | 否 | 文件水印信息。 | 測試 |
| Tid | long | 否 | 租戶 ID。 說明
取自系統(tǒng)右上角頭像處懸停展示的租戶 ID 信息，詳情請參見查看租戶信息。
| 3*** |
| RealLoginUserUid | string | 否 | 實際調(diào)用 API 的用戶的阿里云賬號 UID。更多信息，請參見指定 API 調(diào)用者。 | 21400447956867**** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"CreateOrderResult": {
"CreateOrderResult": [
0
]
},
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-07-11 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |