Displays the DBS restoration job list.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeRestoreTaskList

The parameter specified by the system. Value: DescribeRestoreTaskList.

BackupPlanId String No dbs1hvb0wwwXXXXX

The ID of the backup plan.

RestoreTaskId String No s102h7rf5anq

The ID of the Restoration Task. Separate multiple task IDs with commas (,).

PageSize Integer Optional 30

The number of records on each page. Valid values:

  • 30
  • 50
  • 100
Note Default value: 30.
PageNum Integer Optional 1

The number of the page to return. Valid values: any non-zero positive Integer. Default value: 0.

RegionId String No cn-hangzhou


ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

The client token that is used to ensure the idempotency of the request.

Response parameters

Parameter Type Example Description
ErrCode String Param.NotFound

The error code.

ErrMessage String The specified parameter %s value is not valid.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

Items Array of RestoreTaskDetail

The details of the backup plan.

BackupGatewayId Long 324234332

The ID of the backup gateway.

BackupPlanId String dbs1hvb0wXXXX

The ID of the backup plan.

BackupSetId String 1ibh2f5uXXX

The ID of the full backup set used for the restoration.

ContinuousRestoreProgress Integer 100

The incremental log restoration progress.

CrossAliyunId String 2xxx7778xxxxxxxxxx

The uid of the backup file.

CrossRoleName String test123

The name of the RAM role used for cross-account backup.

DestinationEndpointDatabaseName String test

The name of the RDS database.

DestinationEndpointInstanceID String rm-bp1p8c2947XXX

The ID of the ApsaraDB RDS instance to query.

DestinationEndpointInstanceType String RDS

The location of the database. Valid values:

  • RDS
  • ECS
  • Express: a database connected over Express connect, VPN Gateway, or smart gateway.
  • agent: The database connected through the backup Gateway
  • dds: apsaradb for MongoDB
  • other: the database is directly connected through IP Address: Port.
DestinationEndpointIpPort String 100.X.X.10:33204

The endpoint used to connect to the database.

DestinationEndpointOracleSID String test

The SID of the Oracle instance.

DestinationEndpointRegion String cn-hangzhou

The region of the database.

DestinationEndpointUserName String test

The database account.

ErrMessage String NULL

The error message.

FullDataRestoreProgress Integer 100

The progress of full data recovery.

FullStruAfterRestoreProgress Integer 100

Full structure Post-Restore progress.

FullStruforeRestoreProgress Integer 0

Full structure pre-recovery progress.

RestoreDir String 100.X.X.10:33204

The recovery path.

RestoreObjects String [ { \"DBName\":\"test\" } ]

Restore an object.

RestoreStatus String running

The restoration job status. Valid values:

  • init: not started or PreCheck failed.
  • running: The check task is running.
  • stop: Failed
  • pause
  • check_pass: Pre-Check passed.
RestoreTaskCreateTime Long 1554560477000

The time when the restoration job was created. Valid value: 1554560477000.

RestoreTaskFinishTime Long 1554560477000

The time when the restoration job was completed. Valid value: 1554560477000.

RestoreTaskId String s1XXXXXX

The ID of the restoration task.

RestoreTaskName String test

The name of the restoration task.

RestoreTime Long 1554560477000

The time when the fault is restored. Set the value to 1554560477000.

PageNum Integer 1

The page number of the page to be returned.

PageSize Integer 30

The number of records per page.

RequestId String 9C397502-B4F2-4E22-AD97-C81F0049F3F3

The ID of the request.

Success Boolean true

Indicates whether the request succeeded.

TotalElements Integer 1

The total number of recovery tasks.

TotalPages Integer 1

The total number of returned pages.


Sample requests

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=DescribeRestoreTaskList
&<Common request parameters>

Sample success responses

XML format

        <RestoreObjects>[     {         "DBName":"test_ygx"       } ]</RestoreObjects>

JSON format

	"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

Error codes

For a list of error codes, visit the API Error Center.