DescribeRestoreRangeInfo - Data Management - Alibaba Cloud Documentation Center

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

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

*All Resource

*

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 it.	dbssl67c7mx****
BeginTimestampForRestore	integer	Yes	The earliest point in time to which you can restore data. You can call the DescribeBackupPlanList operation to obtain the value of the parameter for each backup schedule.	1646674092000
EndTimestampForRestore	integer	Yes	The latest point in time to which you can restore data. You can call the DescribeBackupPlanList operation to obtain the value of the 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 elements

Element	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	object
DBSRecoverRange	array<object>	The information about the time ranges to which you can restore data.
	array<object>	The information about the time range to which you can restore data.
EndTimestampForRestore	integer	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	integer	The beginning of the time range to which you can restore data.	1646760282000
SourceEndpointInstanceID	string	The ID of the database instance.	rm-bp106x9tk2c91****
FullBackupList	object
FullBackupDetail	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.
	object	The details of the backup point.
EndTime	integer	The end time of the full backup task. Example: 1646760308000.	1646760308000
StartTime	integer	The start time of the full backup task. Example: 1646760282000.	1646760282000
BackupSetId	string	The ID of the backup set.	qecnsxkd****

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

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.