All Products
Search

This Product

    ApsaraDB RDS:DescribeLocalAvailableRecoveryTime

    Document Center

    ApsaraDB RDS:DescribeLocalAvailableRecoveryTime

    Last Updated:Apr 17, 2024

    Queries the time range to which an RDS instance can be restored.

    Operation description

    Supported database engines

    • MySQL
    • PostgreSQL
    • MariaDB

    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
    rds:DescribeLocalAvailableRecoveryTimeREAD
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The instance ID.

    		rm-uf6wjk5xxxxxxx
    RegionstringNo

    The region ID. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    ResourceGroupIdstringNo

    The resource group ID.

    		rg-acfmy*****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RecoveryEndTimestring

    The end of the time range to which the instance can be restored.

    		2020-03-20T08:41:29Z
    DBInstanceIdstring

    The instance ID.

    		rm-uf6wjk5xxxxxxx
    RequestIdstring

    The request ID.

    		14E986AC-0F27-4FFB-8EED-9A8A3A2A0309
    RecoveryBeginTimestring

    The start of the time range to which the instance can be restored.

    		2020-03-16T07:59:18Z

    Examples

    Sample success responses

    JSONformat

    {
  "RecoveryEndTime": "2020-03-20T08:41:29Z",
  "DBInstanceId": "rm-uf6wjk5xxxxxxx",
  "RequestId": "14E986AC-0F27-4FFB-8EED-9A8A3A2A0309",
  "RecoveryBeginTime": "2020-03-16T07:59:18Z"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ParameterLeastAssociateMust input at least one optional parameterYou must enter at least one selectable parameter.
    400InvalidParameters.FormatSpecified parameter is not validThe operation failed. The values of some parameters are invalid.
    400ParameterAbsenceNecessary parameter is absence.You must pass in the required parameter.
    400MissingUserIDThe request is missing a user_id parameter.The user ID cannot be found.
    400MissingUIDThe request is missing a uid parameter.The operation failed. The UID in the request is left unspecified.
    400LogBackupNotEnabledSpecified instance does not enabled logbackupLog backup is not enabled for the specified instance.
    403IncorrectDBInstanceCharacterTypeCurrent DB Instance character_type does not support this operation.This operation is not supported for the character type of the current instance.
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
    403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.The operation failed. The RDS instance is locked.
    404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.The RDS instance cannot be found, is deleted, or does not support the operation.
    404InvalidUser.NotFoundSpecified user does not exist.The specified user is not found. Please check again.
    404InvalidBinlog.NotFoundThe available binlog does not exist in recovery time.The binary log file at the specified point in time is invalid.
    404InvalidBackup.NotFoundThe available backup does not exist in recovery time.No available data backup file can be used to restore data.

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

    Change history

    Change timeSummary of changesOperation
    2022-09-01The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 404 change
      delete Error Codes: 403