DescribeRestoreTaskList API參考與查詢恢複工作清單-Data Management-阿里雲

該介面用於查看DBS恢複工作清單。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dbs:DescribeRestoreTaskList

get

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

無

請求參數

名稱	類型	必填	描述	樣本值
BackupPlanId	string	否	備份計劃 ID。說明請填入本參數 BackupPlanId 或 RestoreTaskId。	dbs1hvb0wwwXXXXX
RestoreTaskId	string	否	恢複任務 ID，支援多個查詢，使用半形逗號（,）分隔。您可以調用 CreateRestoreTask 介面擷取該參數。說明請填入本參數 RestoreTaskId 或 BackupPlanId，同時填入時會導致報錯。	s102h7rf5anq
PageSize	integer	否	每頁的記錄數，取值為 1~100。說明預設為 30。	30
PageNum	integer	否	頁碼，大於等於 0 且不超過 Integer 的最大值，預設值為：0。	1
ClientToken	string	否	用於保證請求的等冪性，防止重複提交請求。	ETnLKlblzczshOTUbOCzxxxxxxx
StartTimestamp	integer	否	開始備份時間。	1570701361528
EndTimestamp	integer	否	結束備份時間。	1570701361528

返回參數

名稱	類型	描述	樣本值
	object	返回參數詳情如下。
HttpStatusCode	integer	HTTP 狀態代碼。	200
PageNum	integer	頁碼。	1
RequestId	string	請求 ID。	9C397502-B4F2-4E22-AD97-C81F0049F3F3
ErrCode	string	錯誤碼。	Param.NotFound
Success	boolean	是否成功。	true
ErrMessage	string	錯誤資訊。	The specified parameter %s value is not valid.
TotalPages	integer	總頁數。	1
TotalElements	integer	總恢複任務數。	1
PageSize	integer	每頁的記錄數。	30
Items	object
RestoreTaskDetail	array<object>	備份計劃詳情。
	object
RestoreStatus	string	恢複任務狀態，取值： init：未啟動或預檢查失敗 running：運行中 stop：失敗 pause：暫停 check_pass：預檢查通過	running
FullStruAfterRestoreProgress	integer	全量結構後置恢複進度。	100
CrossRoleName	string	跨阿里雲帳號備份的 RAM 角色名稱。	test123
RestoreDir	string	復原路徑。	100.X.X.10:33204
CrossAliyunId	string	跨阿里雲帳號備份的 UID。	2xxx7778xxxxxxxxxx
RestoreObjects	string	恢複對象。	[ { \"DBName\":\"test\" } ]
BackupPlanId	string	備份計劃 ID。	dbs1hvb0wXXXX
DestinationEndpointRegion	string	資料庫地區。	cn-hangzhou
RestoreTaskCreateTime	integer	恢複任務建立時間，取值：1554560477000。	1554560477000
DestinationEndpointUserName	string	資料庫帳號。	test
RestoreTaskFinishTime	integer	恢複任務完成時間，取值：1554560477000。	1554560477000
DestinationEndpointIpPort	string	資料庫連接地址。	100.X.X.10:33204
DestinationEndpointDatabaseName	string	資料庫名稱。	test
DestinationEndpointInstanceType	string	資料庫所在位置，取值： RDS ECS Express：通過專線/VPN 閘道/智能網關接入的資料庫 agent：通過備份網關接入的資料庫 dds：雲 MongoDB other：通過 IP:Port 直連的資料庫	RDS
DestinationEndpointOracleSID	string	Oracle SID 名稱。	test
FullStruforeRestoreProgress	integer	全量結構前置恢複進度。	0
ErrMessage	string	錯誤資訊。	NULL
RestoreTaskId	string	恢複任務 ID。	s1XXXXXX
FullDataRestoreProgress	integer	全量資料恢複進度。	100
ContinuousRestoreProgress	integer	增量日誌恢複進度。	100
DestinationEndpointInstanceID	string	資料庫執行個體 ID。	rm-bp1p8c2947XXX
BackupSetId	string	恢複所使用的全量備份組 ID。	1ibh2f5uXXX
BackupGatewayId	integer	備份網關 ID。	324234332
RestoreTaskName	string	恢複任務名稱。	test
RestoreTime	integer	恢復，取值：1554560477000。	1554560477000
DestinationEndpointHost	string		127.0.0.1
DestinationEndpointPort	string		3306
DestinationEndpointEnableSsl	string		true
BackupGatewayIdentifier	string		TESTGATEWAY
BackupSourceOssRegion	string		cn-beijing
RestoreDestinationMode	string		EXIST_INSTANCE
PhysicalFullBackupRecoverProgress	integer
PhysicalFullAndIncrementBackupRecoverProgress	integer
PhysicalIncrementBackupRecoverProgress	integer
PhysicalDatabaseOnlineProgress	integer
PhysicalBackupRecoverProgress	integer

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "9C397502-B4F2-4E22-AD97-C81F0049F3F3",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "RestoreTaskDetail": [
      {
        "RestoreStatus": "running",
        "FullStruAfterRestoreProgress": 100,
        "CrossRoleName": "test123",
        "RestoreDir": "100.X.X.10:33204",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "RestoreObjects": "[     {         \\\"DBName\\\":\\\"test\\\"       } ]",
        "BackupPlanId": "dbs1hvb0wXXXX",
        "DestinationEndpointRegion": "cn-hangzhou",
        "RestoreTaskCreateTime": 1554560477000,
        "DestinationEndpointUserName": "test",
        "RestoreTaskFinishTime": 1554560477000,
        "DestinationEndpointIpPort": "100.X.X.10:33204",
        "DestinationEndpointDatabaseName": "test",
        "DestinationEndpointInstanceType": "RDS",
        "DestinationEndpointOracleSID": "test",
        "FullStruforeRestoreProgress": 0,
        "ErrMessage": "NULL",
        "RestoreTaskId": "s1XXXXXX",
        "FullDataRestoreProgress": 100,
        "ContinuousRestoreProgress": 100,
        "DestinationEndpointInstanceID": "rm-bp1p8c2947XXX",
        "BackupSetId": "1ibh2f5uXXX",
        "BackupGatewayId": 324234332,
        "RestoreTaskName": "test",
        "RestoreTime": 1554560477000,
        "DestinationEndpointHost": "127.0.0.1",
        "DestinationEndpointPort": "3306",
        "DestinationEndpointEnableSsl": "true",
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "BackupSourceOssRegion": "cn-beijing",
        "RestoreDestinationMode": "EXIST_INSTANCE",
        "PhysicalFullBackupRecoverProgress": 0,
        "PhysicalFullAndIncrementBackupRecoverProgress": 0,
        "PhysicalIncrementBackupRecoverProgress": 0,
        "PhysicalDatabaseOnlineProgress": 0,
        "PhysicalBackupRecoverProgress": 0
      }
    ]
  }
}

錯誤碼

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

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

變更歷史

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