使用GetOnlineDDLProgress擷取OnlineDDL任務執行進度詳情-Data Management-阿里雲

調用GetOnlineDDLProgress介面，擷取OnlineDDL任務執行進度詳情。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetOnlineDDLProgress

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Tid	integer	否	租戶 ID。說明取自系統右上方頭像處懸停展示的租戶 ID 資訊，詳情請參見查看租戶資訊。	3***
JobDetailId	integer	是	OnlineDDL SQL 任務詳情 ID。您可通過調用 ListDBTaskSQLJobDetail 介面擷取該參數的值。	15***

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	34E01EDD-6A16-4CF0-9541-C644D1BE01AA
Success	boolean	請求是否成功。傳回值如下： true：請求成功 false：請求失敗	true
ErrorMessage	string	錯誤資訊。	UnknownError
ErrorCode	string	錯誤碼。	403
OnlineDDLTaskDetail	object	任務詳細資料。
JobStatus	string	任務狀態。傳回值如下： INIT：初始化。 SUCCESS：已完成。 RUNNING：執行中。 WAITING_CUTOVER：等待 cut-over。 RESTARTING：重啟中。 PAUSE：暫停中。 UNSUPPORTED：不支援。 CANCELED：已取消。 FAIL：已失敗。 INTERRUPT：已中止。	SUCCESS
StatusDesc	string	任務狀態原因資訊。	Success
DelaySeconds	integer	DMS 回放延遲，即回放原表的 Binlog 到暫存資料表的延遲時間（單位：秒），與資料庫的主備無關。	0
CopyTotal	integer	預估的資料總行數，取自 information_schema 庫的統計資料，通常比表中的真實資料量小。	10
CopyCount	integer	DMS 無鎖變更實際拷貝的原表資料量。	9
ProgressRatio	string	預估的執行進度。具體以任務狀態為準。	90%
CutoverLockTimeSeconds	integer	切換表時，鎖表逾時時間。	2
CutoverFailRetryTimes	integer	切換表失敗時重試次數。	3
CleanStrategy	string	完成切換表操作後，原表的清理策略，傳回值如下： DROP：系統自動刪除無效原表。 MOVE：將無效原表移動到 test 資料庫，再進行手動清理。 NOTHING：原庫中保留無效原表，再進行手動清理。	DROP
CopyChunkSize	integer	全量拷貝大小。該參數用於指定每個小塊的大小。單次拷貝塊越大，全量拷貝時間越短，但同時對業務影響越大。說明在全量拷貝階段，將原表分為 N 個小塊逐個拷貝到暫存資料表，DMS 預設動態調整每個塊的大小。	1000
CopyChunkMode	string	全量拷貝策略，傳回值如下： AUTO：DMS 根據資料庫的效能動態調整，單次拷貝鎖表時間控制在 1.5 秒以內。 RUNNING：DMS 根據您指定的 CopyChunkSize 大小（1-60000）拷貝原表資料，此模式下必須設定 CopyChunkSize。	AUTO
CutoverWindowStartTime	string	切換表的時間視窗開始時間。預設為 00:00:00。該參數可以控制切換表的時間視窗，指定當滿足切換表條件且在時間視窗以內時才可以切換，未在視窗內時則一直等待視窗。	12:00:00
CutoverWindowEndTime	string	切換表的時間視窗結束時間，與 CutoverWindowStartTime 至少間隔 30 分鐘。預設為 23:59:59。	13:00:00

樣本

正常返回樣本

JSON格式

{
  "RequestId": "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "403",
  "OnlineDDLTaskDetail": {
    "JobStatus": "SUCCESS",
    "StatusDesc": "Success",
    "DelaySeconds": 0,
    "CopyTotal": 10,
    "CopyCount": 9,
    "ProgressRatio": "90%",
    "CutoverLockTimeSeconds": 2,
    "CutoverFailRetryTimes": 3,
    "CleanStrategy": "DROP",
    "CopyChunkSize": 1000,
    "CopyChunkMode": "AUTO",
    "CutoverWindowStartTime": "12:00:00",
    "CutoverWindowEndTime": "13:00:00"
  }
}

錯誤碼

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

變更歷史

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