All Products
Search
Document Center

Database Backup:DescribeRestoreRangeInfo

Last Updated:Mar 03, 2024

Queries the details of time ranges to which you can restore data in a specified backup schedule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dbs:DescribeRestoreRangeInfoRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

ETnLKlblzczshOTUbOCzxxxxxxx

dbssl67c7mx****
BeginTimestampForRestorelongYes

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.

1646674092000
EndTimestampForRestorelongYes

The end of the time range to which you can restore data.

1646846814000
ClientTokenstringNo

The information about the time range to which you can restore data.

ETnLKlblzczshOTUbOCzxxxxxxx
RecentlyRestorebooleanNo

The response parameters.

true

Response parameters

ParameterTypeDescriptionExample
object

The location of the database.

HttpStatusCodeinteger

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.

200
RequestIdstring

The information about the time ranges to which you can restore data.

E2BD9DFC-6760-5F49-97C5-DA739E29****
ErrCodestring

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.

Param.NotFound
Successboolean

The end time of the full backup task. Example: 1646760308000.

true
ErrMessagestring

Specifies whether to query the most recent point in time to which you can restore data.

The specified parameter %s value is not valid.
Itemsobject []

true

EndTimestampForRestorelong

The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID of the backup schedule.

1646760308000
SourceEndpointInstanceTypestring

The error code.

rds
RangeTypestring

The ID of the database instance.

point
BeginTimestampForRestorelong

The error message.

1646760282000
SourceEndpointInstanceIDstring

The client token that is used to ensure the idempotence of the request.

rm-bp106x9tk2c91****
FullBackupListobject []

The ID of the backup set.

EndTimelong

Queries the details of time ranges to which you can restore data in a specified backup schedule.

1646760308000

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

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

Change history

Change timeSummary of changesOperation
No change history