Plan Data Recovery Using DescribeRestoreRangeInfo for Backup Windows - Data Management - Alibaba Cloud - Data Management

This operation returns the time ranges available for restoring data from a backup plan.

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:DescribeRestoreRangeInfo

get

*BackupPlan

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

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup plan. Call DescribeBackupPlanList to get this value.	dbssl67c7mx****
BeginTimestampForRestore	integer	Yes	The start timestamp of the restorable time range. Call DescribeBackupPlanList to get this value.	1646674092000
EndTimestampForRestore	integer	Yes	The end timestamp of the restorable time range. Call DescribeBackupPlanList to get this value.	1646846814000
ClientToken	string	No	A client token that ensures the idempotence of requests and prevents duplicate submissions.	ETnLKlblzczshOTUbOCzxxxxxxx
RecentlyRestore	boolean	No	Whether to enable recent restore.	true

Response elements

Element	Type	Description	Example
	object	The response contains the following fields.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	E2BD9DFC-6760-5F49-97C5-DA739E29****
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request succeeded. Valid values: true: The request succeeded. false: The request failed.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
Items	object
DBSRecoverRange	array<object>	Restorable time range information.
	array<object>	Detailed records.
EndTimestampForRestore	integer	The end timestamp of the restorable time range.	1646760308000
SourceEndpointInstanceType	string	The location of the database.	rds
RangeType	string	The type of restorable time range. Valid values: point: A discrete point in time for a full backup. range: A continuous backup time range. You can specify any time within this range.	point
BeginTimestampForRestore	integer	The start timestamp of the restorable time range.	1646760282000
SourceEndpointInstanceID	string	The ID of the database instance.	rm-bp106x9tk2c91****
FullBackupList	object
FullBackupDetail	array<object>	If RangeType is point, this field lists all backup points in the time range.
	object	Detailed information.
EndTime	integer	The end time of the full backup. Example: 1646760308000.	1646760308000
StartTime	integer	The start time of the full backup. Example: 1646760282000.	1646760282000
BackupSetId	string	The ID of the backup set.	qecnsxkd****
BackupSourceInstanceType	string		rds
BackupSourceInstanceId	string		rm-testxx
BackupSourceHost	string		127.0.0.1
BackupSourcePort	string		3306

Examples

Success response

JSON format

{
  "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****"
            }
          ]
        },
        "BackupSourceInstanceType": "rds",
        "BackupSourceInstanceId": "rm-testxx",
        "BackupSourceHost": "127.0.0.1",
        "BackupSourcePort": "3306"
      }
    ]
  }
}

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.