CreateDataExportOrder - 建立SQL結果集匯出工單
建立SQL結果集匯出工單。
介面說明
僅管控模式為安全協同的資料庫執行個體可調用此 API。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dms:CreateDataExportOrder |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ParentId |
integer |
否 |
父工單 ID。 |
877**** |
| Comment |
string |
是 |
業務背景,描述提工單的原因,以減少溝通成本。 |
業務測試。 |
| AttachmentKey |
string |
否 |
工單附件 Key,補充當前工單資訊。可通過調用介面 GetUserUploadFileJob 擷取該參數的值。 |
order_attachment.txt |
| RelatedUserList |
array |
否 |
相關人列表。 |
|
|
integer |
否 |
變更相關人的使用者識別碼,非阿里雲 UID。設定的相關人員可查看工單,並協同工作,非相關人員則不能查看工單(管理員、DBA 除外)。 |
2452345113**** |
|
| PluginParam |
object |
是 |
工單參數。 |
|
| AffectRows |
integer |
是 |
預估影響 SQL 行數。 |
1 |
| Classify |
string |
是 |
匯出工單的原因類別。 |
測試 |
| InstanceId |
integer |
是 |
執行個體 ID。 |
132**** |
| DbId |
integer |
是 |
資料庫 ID。 |
18**** |
| Logic |
boolean |
是 |
是否為邏輯庫,取值如下:
說明
如果取值為 true,目標資料庫必須為邏輯庫。 |
true |
| IgnoreAffectRows |
boolean |
是 |
是否跳過 SQL 行數校正,傳回值如下:
|
true |
| IgnoreAffectRowsReason |
string |
否 |
跳過 SQL 行數校正的原因。當您需要跳過行數校正時必須填該參數。 |
僅測試,不影響業務,無需校正。 |
| ExeSQL |
string |
是 |
執行的匯出 SQL 陳述式。 |
SELECT * FROM DMS_test LIMIT 20; |
| Watermark |
object |
否 |
浮水印相關資訊。 |
|
| WatermarkTypes |
array |
否 |
浮水印嵌入類型。 |
|
|
string |
否 |
取值如下:
浮水印的詳細資料,請參見資料浮水印。 |
DATA |
|
| Keys |
array |
否 |
主鍵或唯一鍵。 |
|
|
string |
否 |
主鍵或唯一鍵資訊,多個資料之間使用英文逗號(,)分割。 |
ID |
|
| ColumnName |
string |
否 |
資料浮水印嵌入欄位名稱。 |
user_number |
| DataWatermark |
string |
否 |
資料浮水印資訊。 |
測試 |
| FileWatermark |
string |
否 |
檔案浮水印資訊。 |
測試 |
| Tid |
integer |
否 |
租戶 ID。 說明
取自系統右上方頭像處懸停展示的租戶 ID 資訊,詳情請參見查看租戶資訊。 |
3*** |
| RealLoginUserUid |
string |
否 |
實際調用 API 的使用者的阿里雲帳號 UID。 |
21400447956867**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID,用於定位日誌,排查問題。 |
7FAD400F-7A5C-4193-8F9A-39D86C4F0231 |
| ErrorCode |
string |
錯誤碼。 |
UnknownError |
| ErrorMessage |
string |
調用失敗時,返回的錯誤資訊。 |
UnknownError |
| CreateOrderResult |
object |
||
| CreateOrderResult |
array |
建立的工單內容。 |
|
|
integer |
工單 ID。 |
819**** |
|
| Success |
boolean |
請求是否成功,傳回值如下:
|
true |
樣本
正常返回樣本
JSON格式
{
"RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"CreateOrderResult": {
"CreateOrderResult": [
0
]
},
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。