Use DescribeRestoreTaskList to Query DBS Restore Jobs - Data Management - Alibaba Cloud - Data Management

Queries restore jobs in Database Backup Service (DBS).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:DescribeRestoreTaskList

get

*BackupPlan

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

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	No	The ID of the backup plan. Note You must specify either this parameter or `RestoreTaskId`.	dbs1hvb0wwwXXXXX
RestoreTaskId	string	No	The ID of the restore task. You can specify multiple IDs, separated by commas. You can call the CreateRestoreTask operation to obtain the restore task ID. Note You must specify either this parameter or `BackupPlanId`. Specifying both parameters returns an error.	s102h7rf5anq
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Note The default value is 30.	30
PageNum	integer	No	The page number. The value must be an integer that is greater than or equal to 0. Default value: 0.	1
ClientToken	string	No	A client-generated token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.	ETnLKlblzczshOTUbOCzxxxxxxx
StartTimestamp	integer	No	The beginning of the time range to query restore tasks. Specify the time in the UNIX timestamp format. The timestamp is a millisecond-level timestamp.	1570701361528
EndTimestamp	integer	No	The end of the time range to query restore tasks. Specify the time in the UNIX timestamp format. The timestamp is a millisecond-level timestamp.	1570701361528

Response elements

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
PageNum	integer	The page number.	1
RequestId	string	The request ID.	9C397502-B4F2-4E22-AD97-C81F0049F3F3
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request was successful.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
TotalPages	integer	The total number of pages returned.	1
TotalElements	integer	The total number of restore jobs.	1
PageSize	integer	The number of entries returned per page.	30
Items	object
RestoreTaskDetail	array<object>	The details of the restore jobs.
	object
RestoreStatus	string	The status of the restore job. Valid values: init: The restore job is initializing or the precheck has failed. running: The restore job is running. stop: The restore job has failed. pause: The restore job is paused. check_pass: The precheck was successful.	running
FullStruAfterRestoreProgress	integer	The progress of the post-restore full schema restoration.	100
CrossRoleName	string	The name of the RAM role used for cross-account backup.	test123
RestoreDir	string	The restore path.	/home/test
CrossAliyunId	string	The UID of the Alibaba Cloud account used for cross-account backup.	2xxx7778xxxxxxxxxx
RestoreObjects	string	The restore objects.	[ { \"DBName\":\"test\" } ]
BackupPlanId	string	The ID of the backup plan.	dbsxxxx
DestinationEndpointRegion	string	The region of the destination instance.	cn-hangzhou
RestoreTaskCreateTime	integer	The time when the restore job was created, represented as a UNIX timestamp in milliseconds.	1554560477000
DestinationEndpointUserName	string	The database account of the destination endpoint.	testUser
RestoreTaskFinishTime	integer	The time when the restore job was completed, represented as a UNIX timestamp in milliseconds.	1554560477000
DestinationEndpointIpPort	string	The connection address of the destination database instance.	100.X.X.10:33204
DestinationEndpointDatabaseName	string	The database name of the destination endpoint.	test
DestinationEndpointInstanceType	string	The type of destination instance. Valid values: RDS ECS Express: A database connected via Express Connect, VPN Gateway, or Smart Access Gateway. Agent: A database connected via a backup gateway. DDS: An ApsaraDB for MongoDB instance. Other: A database connected over the internet via an IP address and port. dg: A self-managed database without a public IP address, connected via Database Gateway (DG).	RDS
DestinationEndpointOracleSID	string	The Oracle SID. Note This parameter is required for Oracle databases.	test
FullStruforeRestoreProgress	integer	The progress of the pre-restore full schema restoration.	100
ErrMessage	string	The error message.	NULL
RestoreTaskId	string	The ID of the restore job.	1iyixxxxxx
FullDataRestoreProgress	integer	The progress of the full data restoration.	100
ContinuousRestoreProgress	integer	The progress of the incremental log restoration.	100
DestinationEndpointInstanceID	string	The ID of the destination instance.	rm-bp1p8c2947XXX
BackupSetId	string	The ID of the full backup set used for the restoration.	urjlfmxxxxx
BackupGatewayId	integer	The ID of the backup gateway.	324234332
RestoreTaskName	string	The name of the restore job.	dbsr1g3xxxx_Restore_Task_1775009514575
RestoreTime	integer	The point in time to which the data is restored, represented as a UNIX timestamp in milliseconds.	1554560477000
DestinationEndpointHost	string	The IP address or domain name of the destination instance.	127.0.0.1
DestinationEndpointPort	string	The port number of the destination database.	3306
DestinationEndpointEnableSsl	string	Indicates whether the connection to the destination database is SSL-encrypted.	true
BackupGatewayIdentifier	string	The unique ID of the backup gateway for the destination endpoint.	TESTGATEWAY
BackupSourceOssRegion	string	The OSS region of the backup source.	cn-beijing
RestoreDestinationMode	string	The method used to restore data to the destination endpoint.	EXIST_INSTANCE
PhysicalFullBackupRecoverProgress	integer	The progress of the full physical restore. This parameter is applicable to physical backups of MySQL and SQL Server.	100
PhysicalFullAndIncrementBackupRecoverProgress	integer	The progress of the full and incremental physical restore. This parameter is applicable to physical backups of MySQL.	100
PhysicalIncrementBackupRecoverProgress	integer	The progress of the incremental physical restore. This parameter is applicable to physical backups of SQL Server.	100
PhysicalDatabaseOnlineProgress	integer	The progress of bringing the database online after a physical restore. This parameter is applicable to physical backups of SQL Server.	100
PhysicalBackupRecoverProgress	integer	The progress of the physical restoration. This parameter is applicable to physical backups of Oracle.	100

Examples

Success response

JSON format

{
  "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
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.