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 Specify either BackupPlanId or RestoreTaskId.	dbs1hvb0wwwXXXXX
RestoreTaskId	string	No	The ID of the restore job. You can specify multiple IDs. Separate them with commas (,). Call the CreateRestoreTask operation to obtain this parameter. Note Specify either RestoreTaskId or BackupPlanId. An error occurs if you specify both parameters.	s102h7rf5anq
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Note Default value: 30.	30
PageNum	integer	No	The page number. The value must be greater than or equal to 0 and not exceed the maximum value of the integer data type. Default value: 0.	1
ClientToken	string	No	A client token that is used to ensure the idempotence of the request. This prevents duplicate requests.	ETnLKlblzczshOTUbOCzxxxxxxx
StartTimestamp	integer	No	The start time of the backup.	1570701361528
EndTimestamp	integer	No	The end time of the backup.	1570701361528

Response elements

Element	Type	Description	Example
	object	The details of the returned 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.	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 job.
	object
RestoreStatus	string	The status of the restore job. Valid values: init: The job is not started or the precheck failed. running: The job is running. stop: The job failed. pause: The job is paused. check_pass: The precheck is passed.	running
FullStruAfterRestoreProgress	integer	The progress of post-restore structure restoration.	100
CrossRoleName	string	The name of the RAM role used for cross-account backup.	test123
RestoreDir	string	The restore path.	100.X.X.10:33204
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.	dbs1hvb0wXXXX
DestinationEndpointRegion	string	The region of the database.	cn-hangzhou
RestoreTaskCreateTime	integer	The time when the restore job was created. This value is a UNIX timestamp. Unit: milliseconds.	1554560477000
DestinationEndpointUserName	string	The database account.	test
RestoreTaskFinishTime	integer	The time when the restore job was completed. This value is a UNIX timestamp. Unit: milliseconds.	1554560477000
DestinationEndpointIpPort	string	The database endpoint.	100.X.X.10:33204
DestinationEndpointDatabaseName	string	The database name.	test
DestinationEndpointInstanceType	string	The location of the database. Valid values: RDS ECS Express: A database connected over a leased line, VPN Gateway, or Smart Access Gateway. agent: A database connected using a backup gateway. dds: An ApsaraDB for MongoDB instance. other: A database connected over the internet.	RDS
DestinationEndpointOracleSID	string	The Oracle system ID (SID).	test
FullStruforeRestoreProgress	integer	The progress of pre-restore structure restoration.	0
ErrMessage	string	The error message.	NULL
RestoreTaskId	string	The ID of the restore job.	s1XXXXXX
FullDataRestoreProgress	integer	The progress of full data restoration.	100
ContinuousRestoreProgress	integer	The progress of incremental log restoration.	100
DestinationEndpointInstanceID	string	The ID of the database instance.	rm-bp1p8c2947XXX
BackupSetId	string	The ID of the full backup set used for the restoration.	1ibh2f5uXXX
BackupGatewayId	integer	The ID of the backup gateway.	324234332
RestoreTaskName	string	The name of the restore job.	test
RestoreTime	integer	The restore time. This value is a UNIX timestamp. Unit: milliseconds.	1554560477000
DestinationEndpointHost	string		127.0.0.1
DestinationEndpointPort	string		3306
DestinationEndpointEnableSsl	string		true
BackupGatewayIdentifier	string		TESTGATEWAY
BackupSourceOssRegion	string		cn-beijing
RestoreDestinationMode	string		EXIST_INSTANCE
PhysicalFullBackupRecoverProgress	integer
PhysicalFullAndIncrementBackupRecoverProgress	integer
PhysicalIncrementBackupRecoverProgress	integer
PhysicalDatabaseOnlineProgress	integer
PhysicalBackupRecoverProgress	integer

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

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.