GetDataExportOrderDetail - 擷取SQL結果集匯出工單詳情

更新時間:
Copy as MD

擷取SQL結果集匯出工單詳情。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetDataExportOrderDetail

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

Tid

integer

租戶 ID。

說明

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

3***

OrderId

integer

工單 ID。可調用 ListOrders 介面擷取該參數的值。

818****

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D

DataExportOrderDetail

object

SQL 結果集匯出工單詳情資訊。

KeyInfo

object

狀態資訊。

PreCheckId

integer

預校正 ID。

6393****

JobStatus

string

匯出工單狀態,取值如下:

  • PRE_CHECKING:執行預校正。

  • PRE_CHECK_SUCCESS:預校正成功。

  • PRE_CHECK_FAIL:預校正失敗。

  • WAITING_APPLY_AUDIT:等待提交審批。

  • APPLY_AUDIT_SUCCESS:提交審批成功。

  • ENABLE_EXPORT:審批通過,允許匯出。

  • WAITING_EXPORT:等待調度進行匯出。

  • DOING_EXPORT:執行匯出。

  • EXPORT_FAIL:匯出失敗。

  • EXPORT_SUCCESS:匯出成功。

EXPORT_SUCCESS

JobId

integer

匯出任務 ID。

1385****

OrderDetail

object

工單詳情資訊。

DbId

integer

資料庫 ID。

3733****

Database

string

匯出的資料庫名稱。

xxx@xxx:3306

Classify

string

匯出工單的原因類別。

text

ExeSQL

string

執行的匯出 SQL 陳述式。

SELECT * FROM DMS_test LIMIT 20;

Logic

boolean

是否為邏輯庫。

false

ActualAffectRows

integer

系統校正影響的 SQL 行數。

1

IgnoreAffectRows

boolean

是否忽略影響行數。

false

IgnoreAffectRowsReason

string

忽略校正原因。

empty

EnvType

string

匯出資料庫環境資訊。

test

ErrorCode

string

錯誤碼。

UnknownError

ErrorMessage

string

錯誤資訊。

UnknownError

Success

boolean

請求是否成功。傳回值如下:

  • true:請求成功。

  • false:請求失敗。

true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "DataExportOrderDetail": {
    "KeyInfo": {
      "PreCheckId": 0,
      "JobStatus": "EXPORT_SUCCESS",
      "JobId": 0
    },
    "OrderDetail": {
      "DbId": 0,
      "Database": "xxx@xxx:3306",
      "Classify": "text",
      "ExeSQL": "SELECT * FROM DMS_test\n LIMIT 20;",
      "Logic": false,
      "ActualAffectRows": 1,
      "IgnoreAffectRows": false,
      "IgnoreAffectRowsReason": "empty",
      "EnvType": "test"
    }
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情