CreateDataExportOrder - 建立SQL結果集匯出工單

更新時間:
Copy as MD

建立SQL結果集匯出工單。

介面說明

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

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

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:邏輯庫

  • false:物理庫

說明

如果取值為 true,目標資料庫必須為邏輯庫。

true

IgnoreAffectRows

boolean

是否跳過 SQL 行數校正,傳回值如下:

  • true

  • false

true

IgnoreAffectRowsReason

string

跳過 SQL 行數校正的原因。當您需要跳過行數校正時必須填該參數。

僅測試,不影響業務,無需校正。

ExeSQL

string

執行的匯出 SQL 陳述式。

SELECT * FROM DMS_test LIMIT 20;

Watermark

object

浮水印相關資訊。

WatermarkTypes

array

浮水印嵌入類型。

string

取值如下:

  • DATA:資料浮水印。

  • FILE:檔案浮水印。

浮水印的詳細資料,請參見資料浮水印

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:請求成功

  • false:請求失敗

true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "7FAD400F-7A5C-4193-8F9A-39D86C4F0231",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "CreateOrderResult": {
    "CreateOrderResult": [
      0
    ]
  },
  "Success": true
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情