View the list of DBS recovery tasks.


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 operation that you want to perform. Set the value to DescribeRestoreTaskList .

BackupPlanId String No dbs1hvb0wwwXXXXX

The ID of the backup schedule.

RestoreTaskId String No s102h7rf5anq

Recovery task ID, supports multiple queries, comma-separated, you can call CreateRestoreTask The interface obtains the parameter.

Note This parameter and the Backup Plan (BackupPlanId) parameter are selected as one of two. When filled in at the same time, an error will be reported.
PageSize Integer No 30

Number of records per page, value:

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

The page number, which is greater than or equal to 0 and does not exceed the maximum value of Integer. The default value is: 0.

RegionId String No cn-hangzhou

The ID of the region. You can call DescribeRegions in the upper-right corner of each metric section.

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

The client token that is used to ensure the idempotency of requests. If an API operation is idempotent, the same result is returned for identical requests.

StartTimestamp Long No 1570701361528

The start time of the backup.

EndTimestamp Long No 1570701361528

The end time of the backup.

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 returned.

HttpStatusCode Integer 200

The HTTP status code.

Items Array of RestoreTaskDetail

Backup plan details.

BackupGatewayId Long 324234332

The ID of the backup gateway.

BackupPlanId String dbs1hvb0wXXXX

The ID of the backup schedule.

BackupSetId String 1ibh2f5uXXX

The ID of the full backup set that is used in the restore task.

ContinuousRestoreProgress Integer 100

The incremental log recovery progress.

CrossAliyunId String 2xxx7778xxxxxxxxxx

The UID of cross-Alibaba Cloud account backup.

CrossRoleName String test123

The name of the RAM role that is backed up across Alibaba Cloud accounts.

DestinationEndpointDatabaseName String test

The name of the database.

DestinationEndpointInstanceID String rm-bp1p8c2947XXX

The ID of the database instance.

DestinationEndpointInstanceType String RDS

The location of the database. Value:

  • RDS
  • ECS
  • Express: a database accessed through leased line /VPN Gateway /smart gateway
  • Agent: The database accessed through the backup Gateway
  • DDS: Cloud MongoDB
  • other: a database directly connected through IP:Port
DestinationEndpointIpPort String 100.X.X.10:33204

The endpoint that is used to connect to the instance.

DestinationEndpointOracleSID String test

The Oracle System ID (SID) of the destination database.

DestinationEndpointRegion String cn-hangzhou

The region where the destination database is deployed.

DestinationEndpointUserName String test

The database account.

ErrMessage String NULL

The error message.

FullDataRestoreProgress Integer 100

Full data recovery progress.

FullStruAfterRestoreProgress Integer 100

Full structure post recovery progress.

FullStruforeRestoreProgress Integer 0

Full structure front recovery progress.

RestoreDir String 100.X.X.10:33204

The recovery path.

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

The objects to restore.

RestoreStatus String running

Restore the task status. Valid values:

  • Init: not started or PreCheck failed
  • running: The nodes are running.
  • Stop: Failed
  • Pause: Pause
  • check_pass: The PreCheck passes
RestoreTaskCreateTime Long 1554560477000

The recovery task creation time. Value: 1554560477000.

RestoreTaskFinishTime Long 1554560477000

The recovery task completion time. Value: 1554560477000.

RestoreTaskId String s1XXXXXX

The recovery task ID.

RestoreTaskName String test

The name of the restore task.

RestoreTime Long 1554560477000

Recovery time, value: 1554560477000.

PageNum Integer 1

The page number of the returned page.

PageSize Integer 30

The number of entries returned per page.

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

The ID of the request.

Success Boolean true

Indicates whether the call is successful.

TotalElements Integer 1

The total number of recovery tasks.

TotalPages Integer 1

The total number of pages returned.


Sample requests

     http(s):// Action=DescribeRestoreTaskList &<Public request parameters> 

Sample success responses

XML format

     <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 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 code

Go to the Error Center See more error codes.