调用DescribeRestoreTaskList接口查询恢复任务列表-数据管理 DMS-阿里云-数据管理 DMS-阿里云帮助中心

该接口用于查看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	恢复路径。	/home/test
CrossAliyunId	string	跨阿里云账号备份的 UID。	2xxx7778xxxxxxxxxx
RestoreObjects	string	恢复对象。	[ { \"DBName\":\"test\" } ]
BackupPlanId	string	备份计划 ID。	dbsxxxx
DestinationEndpointRegion	string	恢复目的端实例所在地域。	cn-hangzhou
RestoreTaskCreateTime	integer	恢复任务创建时间（毫秒）。	1554560477000
DestinationEndpointUserName	string	恢复目的端数据库账号。	testUser
RestoreTaskFinishTime	integer	恢复任务完成时间（毫秒）。	1554560477000
DestinationEndpointIpPort	string	恢复目的端数据库实例连接地址。	100.X.X.10:33204
DestinationEndpointDatabaseName	string	恢复目的端数据库名称。	test
DestinationEndpointInstanceType	string	数据库所在位置，取值： RDS ECS Express：通过专线/VPN 网关/智能网关接入的数据库 Agent：通过备份网关接入的数据库 DDS：云 MongoDB Other：通过 IP:Port 直连的数据库 dg：无公网 IP:Port 的自建数据库（通过数据库网关 DG 接入）	RDS
DestinationEndpointOracleSID	string	Oracle SID 名称。说明数据库类型为 Oracle 时，该参数必传。	test
FullStruforeRestoreProgress	integer	全量结构前置恢复进度。	100
ErrMessage	string	错误信息。	NULL
RestoreTaskId	string	恢复任务 ID。	1iyixxxxxx
FullDataRestoreProgress	integer	全量数据恢复进度。	100
ContinuousRestoreProgress	integer	增量日志恢复进度。	100
DestinationEndpointInstanceID	string	恢复目的端数据库实例 ID	rm-bp1p8c2947XXX
BackupSetId	string	恢复所使用的全量备份集 ID。	urjlfmxxxxx
BackupGatewayId	integer	备份网关 ID。	324234332
RestoreTaskName	string	恢复任务名称。	dbsr1g3xxxx_Restore_Task_1775009514575
RestoreTime	integer	恢复时间点（毫秒）。	1554560477000
DestinationEndpointHost	string	恢复目的端数据库连接地址	127.0.0.1
DestinationEndpointPort	string	恢复目的端数据库端口	3306
DestinationEndpointEnableSsl	string	恢复目的端数据库是否开启 SSL 安全连接	true
BackupGatewayIdentifier	string	恢复目的端备份网关唯一标识码	TESTGATEWAY
BackupSourceOssRegion	string	备份源 OSS 所在地域	cn-beijing
RestoreDestinationMode	string	恢复至目的端方式	EXIST_INSTANCE
PhysicalFullBackupRecoverProgress	integer	物理全量恢复进度。（适用于 MySQL、SqlServer 物理备份）	100
PhysicalFullAndIncrementBackupRecoverProgress	integer	物理全量增量恢复进度。（适用于 MySQL 物理备份）	100
PhysicalIncrementBackupRecoverProgress	integer	物理增量恢复进度。（适用于 SqlServer 物理备份）	100
PhysicalDatabaseOnlineProgress	integer	物理数据库在线进度。（适用于 SqlServer 物理备份）	100
PhysicalBackupRecoverProgress	integer	物理备份恢复进度。（适用于 Oracle 物理备份）	100

示例

正常返回示例

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": "/home/test",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "RestoreObjects": "[ { \\\"DBName\\\":\\\"test\\\" } ]",
        "BackupPlanId": "dbsxxxx",
        "DestinationEndpointRegion": "cn-hangzhou",
        "RestoreTaskCreateTime": 1554560477000,
        "DestinationEndpointUserName": "testUser",
        "RestoreTaskFinishTime": 1554560477000,
        "DestinationEndpointIpPort": "100.X.X.10:33204",
        "DestinationEndpointDatabaseName": "test",
        "DestinationEndpointInstanceType": "RDS",
        "DestinationEndpointOracleSID": "test",
        "FullStruforeRestoreProgress": 100,
        "ErrMessage": "NULL",
        "RestoreTaskId": "1iyixxxxxx",
        "FullDataRestoreProgress": 100,
        "ContinuousRestoreProgress": 100,
        "DestinationEndpointInstanceID": "rm-bp1p8c2947XXX",
        "BackupSetId": "urjlfmxxxxx",
        "BackupGatewayId": 324234332,
        "RestoreTaskName": "dbsr1g3xxxx_Restore_Task_1775009514575",
        "RestoreTime": 1554560477000,
        "DestinationEndpointHost": "127.0.0.1",
        "DestinationEndpointPort": "3306",
        "DestinationEndpointEnableSsl": "true",
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "BackupSourceOssRegion": "cn-beijing",
        "RestoreDestinationMode": "EXIST_INSTANCE",
        "PhysicalFullBackupRecoverProgress": 100,
        "PhysicalFullAndIncrementBackupRecoverProgress": 100,
        "PhysicalIncrementBackupRecoverProgress": 100,
        "PhysicalDatabaseOnlineProgress": 100,
        "PhysicalBackupRecoverProgress": 100
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	Request.Forbidden	Have no Permissions	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。