使用DescribePreCheckProgressList查看備份計劃與恢複任務的預檢查進度-Data Management-阿里雲

該介面用於查看備份計劃預檢查進度和恢複任務預檢查進度。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dbs:DescribePreCheckProgressList

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
BackupPlanId	string	否	備份計劃 ID。說明請填入 BackupPlanId 或 RestoreTaskId。	dbsr1l3ro21****
RestoreTaskId	string	否	恢複任務 ID。	dbasdsa****
ClientToken	string	否	用於保證請求的等冪性，防止重複提交請求。	ETnLKlblzczshOTUbOCziJZNwH****

返回參數

名稱	類型	描述	樣本值
	object	返回參數詳情如下。
Status	string	預檢查狀態，傳回值如下： running：運行中 failed：失敗 finish：完成	finish
HttpStatusCode	integer	HTTP 狀態代碼。	200
RequestId	string	請求 ID。	C4A45FE1-A903-470D-B113-F12A4DF942AB
Progress	integer	預檢查進度，傳回值範圍：0~100。	100
ErrCode	string	錯誤碼。	Param.NotFound
Success	boolean	返回是否成功，傳回值如下： true：返回成功 false：返回失敗	true
ErrMessage	string	錯誤資訊。	The specified parameter %s value is not valid.
Items	object
PreCheckProgressDetail	array<object>	進度明細列表。
	object	返回參數。
FinishTime	integer	完成時間，格式為 Unix 時間戳記。	1704351396000
State	string	進度狀態，傳回值如下： init：初始化 warning：警告 catched：異常 running：運行中 failed：失敗 finish：完成	warning
BootTime	integer	啟動時間，格式為 Unix 時間戳記。	1704351395000
JobId	string	進度 ID。	qxwmxh2b****
Item	string	檢查項編碼。	CHECK_BINLOG_ON
ErrMsg	string	異常資訊。	java.lang.RuntimeException: Could not find any schema ......
OrderNum	string	序號。	30
Names	string	檢查項分組。	CHECK_BINLOG_ON_DETAIL

樣本

正常返回樣本

JSON格式

{
  "Status": "finish",
  "HttpStatusCode": 200,
  "RequestId": "C4A45FE1-A903-470D-B113-F12A4DF942AB",
  "Progress": 100,
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Items": {
    "PreCheckProgressDetail": [
      {
        "FinishTime": 1704351396000,
        "State": "warning",
        "BootTime": 1704351395000,
        "JobId": "qxwmxh2b****",
        "Item": "CHECK_BINLOG_ON",
        "ErrMsg": "java.lang.RuntimeException: Could not find any schema ......",
        "OrderNum": "30",
        "Names": "CHECK_BINLOG_ON_DETAIL"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Request.Forbidden	Have no Permissions	當前操作未被授權，請聯絡主帳號在RAM控制台進行授權後再執行操作

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

變更歷史

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