All Products
Search
Document Center

Database Backup:DescribeSandboxRecoveryTime

Last Updated:Nov 16, 2022

Views the recoverable time range of a sandbox instance.

Operation Description

Before you call this operation, you must enable the sandbox feature for the database instance. For more information, see Create a sandbox instance for emergency disaster recovery of an ApsaraDB RDS for MySQL database or Create a sandbox instance for emergency disaster recovery of a self-managed MySQL database. The API operation is available only in Database Backup (DBS) API of the 2021-01-01 version.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
dbs:DescribeSandboxRecoveryTimeRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID of the backup schedule. If you set this parameter to the backup schedule ID obtained by calling the DescribeBackupPlanList operation, the dbs prefix must be removed. Otherwise, the call fails.

NoteIf your instance is an ApsaraDB RDS for MySQL instance, you can configure automatic access to the instance to automatically add the instance to DBS and obtain the ID of the backup schedule.
1jyjal15l****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCodestring

The error code.

Param.NotFound
Successstring

Indicates whether the request is successful.

true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
Codestring

The error code.

Param.NotFound
Messagestring

The error message.

The specified parameter %s value is not valid.
Dataobject

The response parameters.

RecoveryEndTimestring

The end of the time range during which the sandbox instance can be restored. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

2021-08-02T12:01:01Z
BackupPlanIdstring

The backup schedule of the sandbox instance.

1hxxxx8xxxxxa
RecoveryBeginTimestring

The beginning of the time range during which the sandbox instance can be restored. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

2021-08-01T12:01:01Z

Example

Normal return example

JSONFormat

{
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "Param.NotFound",
  "Success": "true",
  "ErrMessage": "The specified parameter %s value is not valid.",
  "Code": "Param.NotFound",
  "Message": "The specified parameter %s value is not valid.",
  "Data": {
    "RecoveryEndTime": "2021-08-02T12:01:01Z",
    "BackupPlanId": "1hxxxx8xxxxxa",
    "RecoveryBeginTime": "2021-08-01T12:01:01Z"
  }
}

Error codes

For a list of error codes, visit the API error center.