查看恢复任务列表 - 数据库备份 DBS

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeRestoreTaskList	系统规定参数，取值：DescribeRestoreTaskList。
BackupPlanId	String	否	dbs1hvb0wwwXXXXX	备份计划ID。
RestoreTaskId	String	否	s102h7rf5anq	恢复任务ID，支持多个查询，逗号分隔，您可以调用CreateRestoreTask接口获取该参数。说明本参数与备份计划（BackupPlanId）参数为二选一，同时填入时会导致报错。
PageSize	Integer	否	30	每页的记录数，取值： 30 50 100 说明默认为30。
PageNum	Integer	否	1	页码，大于等于0且不超过Integer的最大值，默认值为：0。
RegionId	String	否	cn-hangzhou	地域ID。您可以调用DescribeRegions查询。
ClientToken	String	否	ETnLKlblzczshOTUbOCzxxxxxxx	用于保证请求的幂等性，防止重复提交请求。
StartTimestamp	Long	否	1570701361528	开始备份时间。
EndTimestamp	Long	否	1570701361528	结束备份时间。

返回数据


名称	类型	示例值	描述
ErrCode	String	Param.NotFound	错误码。
ErrMessage	String	The specified parameter %s value is not valid.	错误信息。
HttpStatusCode	Integer	200	HTTP状态码。
Items	Array of RestoreTaskDetail		备份计划详情。
RestoreTaskDetail
BackupGatewayId	Long	324234332	备份网关ID。
BackupPlanId	String	dbs1hvb0wXXXX	备份计划ID。
BackupSetId	String	1ibh2f5uXXX	恢复所使用的全量备份集ID。
ContinuousRestoreProgress	Integer	100	增量日志恢复进度。
CrossAliyunId	String	2xxx7778xxxxxxxxxx	跨阿里云账号备份的uid。
CrossRoleName	String	test123	跨阿里云账号备份的RAM角色名称。
DestinationEndpointDatabaseName	String	test	数据库名称。
DestinationEndpointInstanceID	String	rm-bp1p8c2947XXX	数据库实例ID。
DestinationEndpointInstanceType	String	RDS	数据库所在位置，取值： RDS ECS Express：通过专线/VPN网关/智能网关接入的数据库 agent：通过备份网关接入的数据库 dds：云MongoDB other：通过IP:Port直连的数据库
DestinationEndpointIpPort	String	100.X.X.10:33204	数据库连接地址。
DestinationEndpointOracleSID	String	test	Oracle SID名称。
DestinationEndpointRegion	String	cn-hangzhou	数据库地域。
DestinationEndpointUserName	String	test	数据库账号。
ErrMessage	String	NULL	错误信息。
FullDataRestoreProgress	Integer	100	全量数据恢复进度。
FullStruAfterRestoreProgress	Integer	100	全量结构后置恢复进度。
FullStruforeRestoreProgress	Integer	0	全量结构前置恢复进度。
RestoreDir	String	100.X.X.10:33204	恢复路径。
RestoreObjects	String	[ { \"DBName\":\"test\" } ]	恢复对象。
RestoreStatus	String	running	恢复任务状态，取值： init：未启动或预检查失败 running：运行中 stop：失败 pause：暂停 check_pass：预检查通过
RestoreTaskCreateTime	Long	1554560477000	恢复任务创建时间，取值：1554560477000。
RestoreTaskFinishTime	Long	1554560477000	恢复任务完成时间，取值：1554560477000。
RestoreTaskId	String	s1XXXXXX	恢复任务ID。
RestoreTaskName	String	test	恢复任务名称。
RestoreTime	Long	1554560477000	恢复时间，取值：1554560477000。
PageNum	Integer	1	页码。
PageSize	Integer	30	每页的记录数。
RequestId	String	9C397502-B4F2-4E22-AD97-C81F0049F3F3	请求ID。
Success	Boolean	true	是否成功。
TotalElements	Integer	1	总恢复任务数。
TotalPages	Integer	1	总页数。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=DescribeRestoreTaskList
&<公共请求参数>

正常返回示例

XML格式

<PageSize>30</PageSize>
<RequestId>9C397502-B4F2-4E22-AD97-C81F0049F3F3</RequestId>
<PageNum>0</PageNum>
<HttpStatusCode>200</HttpStatusCode>
<TotalElements>1</TotalElements>
<Items>
    <RestoreTaskDetail>
        <FullStruAfterRestoreProgress>0</FullStruAfterRestoreProgress>
        <FullStruforeRestoreProgress>0</FullStruforeRestoreProgress>
        <BackupSetId>1ibXXXXX7qw</BackupSetId>
        <RestoreStatus>check_pass</RestoreStatus>
        <DestinationEndpointInstanceType>rds</DestinationEndpointInstanceType>
        <RestoreTime>1583741465000</RestoreTime>
        <DestinationEndpointRegion>cn-hangzhou</DestinationEndpointRegion>
        <FullDataRestoreProgress>0</FullDataRestoreProgress>
        <RestoreTaskId>s10XXXXnq</RestoreTaskId>
        <DestinationEndpointIpPort>100.X.X.10:33204</DestinationEndpointIpPort>
        <DestinationEndpointUserName>testygx</DestinationEndpointUserName>
        <RestoreObjects>[     {         "DBName":"test_ygx"       } ]</RestoreObjects>
        <RestoreTaskName>test</RestoreTaskName>
        <BackupPlanId>dbs1hvb0wwweusfa</BackupPlanId>
        <RestoreTaskCreateTime>1583743872000</RestoreTaskCreateTime>
        <DestinationEndpointInstanceID>rm-bp1p8c29479jv8pxe</DestinationEndpointInstanceID>
    </RestoreTaskDetail>
</Items>
<TotalPages>1</TotalPages>
<Success>true</Success>

JSON格式

{
	"PageSize": 30,
	"RequestId": "9C397502-B4F2-4E22-AD97-C81F0049F3F3",
	"PageNum": 0,
	"HttpStatusCode": 200,
	"TotalElements": 1,
	"Items": {
		"RestoreTaskDetail": [
			{
				"FullStruAfterRestoreProgress": 0,
				"FullStruforeRestoreProgress": 0,
				"BackupSetId": "1ibXXXXX7qw",
				"RestoreStatus": "check_pass",
				"DestinationEndpointInstanceType": "rds",
				"RestoreTime": 1583741465000,
				"DestinationEndpointRegion": "cn-hangzhou",
				"FullDataRestoreProgress": 0,
				"RestoreTaskId": "s10XXXXnq",
				"DestinationEndpointIpPort": "100.X.X.10:33204",
				"DestinationEndpointUserName": "testygx",
				"RestoreObjects": "[     {         \"DBName\":\"test_ygx\"       } ]",
				"RestoreTaskName": "test",
				"BackupPlanId": "dbs1hvb0wwweusfa",
				"RestoreTaskCreateTime": 1583743872000,
				"DestinationEndpointInstanceID": "rm-bp1p8c29479jv8pxe"
			}
		]
	},
	"TotalPages": 1,
	"Success": true
}

错误码

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