使用GetDataCorrectOrderDetail擷取資料變更工單詳細資料-Data Management-阿里雲

擷取資料變更工單詳細資料。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetDataCorrectOrderDetail

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Tid	integer	否	租戶 ID，可通過調用介面 GetUserActiveTenant 或 ListUserTenants 擷取該參數的值。	3***
OrderId	integer	是	工單 ID，可通過調用介面 ListOrders 擷取該參數的值。	420****

返回參數

名稱	類型	描述	樣本值
	object	返回參數。
RequestId	string	請求 ID。	427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
DataCorrectOrderDetail	object	資料變更工單詳情資訊。
PreCheckDetail	object
TaskCheckDO	array<object>	預校正詳情資訊列表。
	object	預校正詳情資訊。
UserTip	string	校正步驟提示資訊。	tip messsage
CheckStatus	string	預校正狀態，傳回值如下： WAITING：等待檢查 RUNNING：檢查中 SUCCESS：通過 FAIL：不通過	SUCCESS
CheckStep	string	檢查步驟，傳回值如下： SQL_PARSE：解析 SQL_TYPE_CHECK：類型檢查 PERMISSION_CHECK：許可權檢查 ROW_CHECK：行數檢查	PERMISSION_CHECK
OrderDetail	object	工單詳情資訊。
RbSQL	string	復原 SQL。	empty
RbAttachmentName	string	復原 SQL 附件。	test
Classify	string	變更原因分類。	test
ExeSQL	string	執行的 SQL 陳述式。	update t1 set name = 'xxx' where id <= 100
EstimateAffectRows	integer	預估影響行數。	100
RbSQLType	string	復原 SQL 類型，傳回值如下： TEXT：文本 ATTACHMENT：附件	text
ActualAffectRows	integer	系統校正的影響行數。	100
IgnoreAffectRows	boolean	是否忽略預校正，傳回值如下： true：忽略預校正 false：不忽略預校正	false
AttachmentName	string	SQL 附件。	xxx
SqlType	string	SQL 類型，傳回值如下： TEXT：文本 ATTACHMENT：附件	text
IgnoreAffectRowsReason	string	忽略預校正原因。	test
DatabaseList	object
Database	array<object>	變更庫資訊列表。
	object
DbId	integer	資料庫 ID。	1860****
DbType	string	資料庫類型。	mysql
Logic	boolean	是否為邏輯庫，傳回值如下： true：邏輯庫。 false：物理庫。	false
SearchName	string	資料庫搜尋名。	xxx@xxx:3306
EnvType	string	環境類型，傳回值如下： product：生產環境 dev：開發環境 pre：預發環境 test：測試環境 sit：SIT 環境 uat：UAT 環境 pet：壓測環境 stag：STAG 環境	product
Status	string	資料變更工單特有的狀態，傳回值如下：說明此狀態與工單狀態代碼不完全等價，若需要得到工單狀態，請通過 GetOrderBaseInfo 返回的 StatusCode 屬性擷取。 new：建立。 precheck：預檢查階段。 precheck_fail：預檢查失敗。 precheck_success：預檢查成功, 等待提交審批。 toaudit：審批中。 approved：審批通過。 reject：審批拒絕。 waiting：任務已提交，待調度處理。 processing：執行中。 success：執行成功。	approved
ExecMode	string	工單執行方式，傳回值如下： COMMITOR : 審批通過後，提交者執行。 AUTO : 審批通過後，自動執行。 LAST_AUDITOR : 審批通過後，最後一個審批人執行。	COMMITOR
ConfigDetail	object	工單配置資訊，主要用於儲存不同資料變更工單類型的差異化配置資訊。
DetailType	string	標識變更工單資訊類型，取值和說明如下： COMMON：普通資料變更。 CHUNK_DML：無鎖變更。 BIG_FILE：資料匯入。 CRON_CLEAR_DATA：歷史資料清理。 PROCEDURE：可程式化對象。	BIG_FILE
FileType	string	當 DetailType 為 BIG_FILE 時，標識資料匯入的檔案類型，取值如下： SQL：SQL 檔案。 CSV：CSV 檔案。 EXCEL：Excel 檔案。 JSON：JSON 檔案，僅 MongoDB 支援。	CSV
CsvTableName	string	資料匯入表名，僅當 DetailType 為 BIG_FILE 時有效，若 FileType 取值為 SQL，則此屬性為空白。	tb_import_tb_name
FileEncoding	string	檔案編碼，注意取值可能為空白，為空白則代表 AUTO，取值如下： AUTO：自動識別 UTF-8：UTF8 編碼 GBK：GBK 編碼 ISO-8859-1：ISO-8859-1 編碼	UTF-8
Cron	boolean	是否為歷史資料清理定時任務，預留欄位，若且唯若 DetailType 為 CRON_CLEAR_DATA 有效。	true
CronCallTimes	integer	當 DetailType 為 CRON_CLEAR_DATA 時有效，表示已調度次數。	0
CronFormat	string	當 DetailType 為 CRON_CLEAR_DATA 時有效，表示定時任務 Cron 運算式。	0 0 2 * * ?
Duration	integer	當 DetailType 為 CRON_CLEAR_DATA 時有效，表示定時清理執行時間長度，單位為小時。當取值大於 0，表示設定了清理時間長度。	1
CronStatus	string	定時任務狀態，為空白表示未調度，其他取值和說明如下： PAUSE：調度暫停。 WAITING：待調度。 SUCCESS：調度完成。	SUCCESS
CronLastCallStartTime	string	最近一次調度時間。	2024-04-19 02:00:00.0
CronNextCallTime	string	下一次調度時間。僅當調度狀態為 SUCCESS 時才會有顯示。	2024-04-19 02:00:00
CurrentTaskId	integer	當前資料變更任務 ID，保留欄位，業務暫時不依賴。	13***
ImportExtConfig	object	當 DetailType 為 BIG_FILE，即為資料匯入工單時，此處提供資料匯入附加配置資訊。
InsertType	string	插入類型，取值如下： INSERT：插入資料時資料庫會檢查主鍵（PrimaryKey），如果出現重複會報錯。 INSERT_IGNORE：如果表中已經存在相同的記錄，則忽略當前新資料。 REPLACE_INTO：如果表中已經有某行資料（根據主鍵或者唯一索引判斷），則先刪除此行資料，然後插入新的資料。說明如果 FileType 為 CSV 或者為 EXCEL，該參數有效。	INSERT
CsvFirstRowIsColumnDef	boolean	CSV 格式的類型，取值如下： true：CSV 表格首行是欄位名。 false：CSV 表格首行是資料。說明如果 FileType 為 CSV 或者為 EXCEL，該參數有效。	true
IgnoreError	boolean	是否忽略報錯，取值： true：忽略，遇到錯誤會跳過當前失敗 SQL 指令碼，繼續執行。 false：不忽略，遇到出錯則中斷後面的 SQL 指令碼，不再執行。	false
ImportMode	string	匯入模式，取值如下： FAST_MODE：極速模式，在執行階段讀取檔案，將 SQL 陳述式直接執行到指定的目標庫。該模式安全性相比安全模式要低，但是執行時效較高。 SAFE_MODE：安全模式，在預檢查階段會解析檔案並將 SQL 或 CSV 資料緩衝入庫，執行時再從緩衝庫中讀出來執行到指定的目標庫。該模式安全性較好，但是執行時效相比極速模式要低。	FAST_MODE
CronExtConfig	object	若且唯若 DetailType 為 CRON_CLEAR_DATA，即為歷史資料清理工單時，此處提供歷史資料清理額外配置資訊。
OptimizeTableAfterEveryClearTimes	integer	是否啟用自動 Optimize table，取值： 0：不啟用。大於 0：啟用，表示每隔多少次清理以後再進行 Optimize table。	0
CurrentClearTaskCount	integer	已進行自動 optimize table 的次數。僅當 OptimizeTableAfterEveryClearTimes 大於 0 時有效。	0
ErrorCode	string	錯誤碼。	UnknownError
ErrorMessage	string	錯誤資訊。	UnknownError
Success	boolean	請求是否成功，傳回值如下： true：請求成功。 false：請求失敗。	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "DataCorrectOrderDetail": {
    "PreCheckDetail": {
      "TaskCheckDO": [
        {
          "UserTip": "tip messsage",
          "CheckStatus": "SUCCESS",
          "CheckStep": "PERMISSION_CHECK"
        }
      ]
    },
    "OrderDetail": {
      "RbSQL": "empty",
      "RbAttachmentName": "test",
      "Classify": "test",
      "ExeSQL": "update t1 set name = 'xxx' where id <= 100",
      "EstimateAffectRows": 100,
      "RbSQLType": "text",
      "ActualAffectRows": 100,
      "IgnoreAffectRows": false,
      "AttachmentName": "xxx",
      "SqlType": "text",
      "IgnoreAffectRowsReason": "test"
    },
    "DatabaseList": {
      "Database": [
        {
          "DbId": 0,
          "DbType": "mysql",
          "Logic": false,
          "SearchName": "xxx@xxx:3306",
          "EnvType": "product"
        }
      ]
    },
    "Status": "approved",
    "ExecMode": "COMMITOR",
    "ConfigDetail": {
      "DetailType": "BIG_FILE",
      "FileType": "CSV",
      "CsvTableName": "tb_import_tb_name",
      "FileEncoding": "UTF-8",
      "Cron": true,
      "CronCallTimes": 0,
      "CronFormat": "0 0 2 * * ?",
      "Duration": 1,
      "CronStatus": "SUCCESS",
      "CronLastCallStartTime": "2024-04-19 02:00:00.0",
      "CronNextCallTime": "2024-04-19 02:00:00\n",
      "CurrentTaskId": 0,
      "ImportExtConfig": {
        "InsertType": "INSERT",
        "CsvFirstRowIsColumnDef": true,
        "IgnoreError": false,
        "ImportMode": "FAST_MODE"
      },
      "CronExtConfig": {
        "OptimizeTableAfterEveryClearTimes": 0,
        "CurrentClearTaskCount": 0
      }
    }
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。