DescribeRestoreRangeInfo - Database Backup - Alibaba Cloud Documentation Center

Queries the range of time to which you can restore data in a backup schedule.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dbs:DescribeRestoreRangeInfo	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID of the backup schedule.	dbssl67c7mx****
BeginTimestampForRestore	long	Yes	The beginning of the time range to which you can restore data. You can call the DescribeBackupPlanList operation to obtain the value of the BeginTimestampForRestore parameter for each backup schedule.	1646674092000
EndTimestampForRestore	long	Yes	The end of the time range to which you can restore data. You can call the DescribeBackupPlanList operation to obtain the value of the EndTimestampForRestore parameter for each backup schedule.	1646846814000
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	ETnLKlblzczshOTUbOCzxxxxxxx
RecentlyRestore	boolean	No	Specifies whether to query the most recent point in time to which you can restore data.	true

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	E2BD9DFC-6760-5F49-97C5-DA739E29****
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
Items	array<object>	The information about the time ranges to which you can restore data.
DBSRecoverRange	object	The information about the time range to which you can restore data.
EndTimestampForRestore	long	The end of the time range to which you can restore data.	1646760308000
SourceEndpointInstanceType	string	The location of the database.	rds
RangeType	string	The type of the time range to which you can restore data. point: The time range contains discrete points in time at which full backups were performed. range: The time range is a period of time for which continuous backup is performed. You can specify a random point in time in the time range to restore data.	point
BeginTimestampForRestore	long	The beginning of the time range to which you can restore data.	1646760282000
SourceEndpointInstanceID	string	The ID of the database instance.	rm-bp106x9tk2c91****
FullBackupList	array<object>	If the value of the RangeType parameter is point, this parameter is returned. The value of this parameter describes information about all backup points in the time range.
FullBackupDetail	object	The details of the backup point.
EndTime	long	The end time of the full backup task. Example: 1646760308000.	1646760308000
StartTime	long	The start time of the full backup task. Example: 1646760282000.	1646760282000
BackupSetId	string	The ID of the backup set.	qecnsxkd****

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "E2BD9DFC-6760-5F49-97C5-DA739E29****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "Items": {
    "DBSRecoverRange": [
      {
        "EndTimestampForRestore": 1646760308000,
        "SourceEndpointInstanceType": "rds",
        "RangeType": "point",
        "BeginTimestampForRestore": 1646760282000,
        "SourceEndpointInstanceID": "rm-bp106x9tk2c91****",
        "FullBackupList": {
          "FullBackupDetail": [
            {
              "EndTime": 1646760308000,
              "StartTime": 1646760282000,
              "BackupSetId": "qecnsxkd****"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history