All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeBackups

    Document Center

    Tair (Redis® OSS-Compatible):DescribeBackups

    Last Updated:Mar 30, 2026

    Queries information about backup files for a Redis-compatible ApsaraDB for Tair instance.

    Operation description

    This operation does not apply to cloud-native cluster instances. Instead, use the DescribeClusterBackupList operation.

    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

    kvstore:DescribeBackups

    get

    *DBInstance

    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the instance.

    r-bp1zxszhcgatnx****
    BackupId

    integer

    No

    The ID of the backup file.

    11611111
    BackupJobId

    integer

    No

    The ID of the backup job returned by the CreateBackup operation. If CreateBackup returns multiple backup job IDs, call this operation for each ID.

    10001
    PageSize

    integer

    No

    The maximum number of entries to return per page. Valid values: 30, 50, 100, 200, and 300.

    30
    PageNumber

    integer

    No

    The page number to return. The value must be greater than 0. The default value is 1.

    1
    StartTime

    string

    Yes

    The start time for the query. Specify the time in UTC using the yyyy-MM-ddTHH:mmZ format.

    2019-03-11T10:00Z
    EndTime

    string

    Yes

    The end time for the query. The end time must be later than the start time. Specify the time in UTC using the yyyy-MM-ddTHH:mmZ format.

    2019-03-14T18:00Z
    NeedAof

    string

    No

    Specifies whether to enable AOF persistence. Valid values:

    • 0: Disabled.

    • 1: Enabled.

    Note

    The default value is 0.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    963C20F0-7CE1-4591-AAF3-6F3CD1CE****
    PageNumber

    integer

    The page number.

    1
    PageSize

    integer

    The number of entries per page.

    30
    TotalCount

    integer

    The total number of backup sets.

    5
    FullStorageSize

    integer

    The total size of full backups for the instance, in bytes. Full backups are generated from scheduled daily backups, manual backups, or cache analysis.

    Note

    This value represents the total size of all valid full backups for the instance, regardless of the backup sets returned in this request.

    1000
    LogStorageSize

    integer

    The total size of log backups for the instance, in bytes. This parameter is returned only if flashback is enabled.

    Note

    This value represents the total size of all valid log backups for the instance, regardless of the backup sets returned in this request.

    5000
    FreeSize

    integer

    This parameter is not in effect. Ignore this parameter.

    100000
    Backups

    object

    Details about the backup sets.

    Backup

    array<object>

    An array of backup sets.

    object

    The details of a backup set.

    BackupStatus

    string

    The backup status. Valid values:

    • Success: The backup was successful.

    • Failed: The backup failed.

    Success
    BackupStartTime

    string

    The start time of the backup.

    2019-03-14T05:28:50Z
    BackupType

    string

    The backup type. Valid values:

    • FullBackup: A full backup.

    • IncrementalBackup: An incremental backup.

    FullBackup
    BackupDownloadURL

    string

    The public download URL of the backup set.

    https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
    NodeInstanceId

    string

    The node ID.

    Note

    For a Standard Edition instance, this parameter returns the instance ID.

    r-bp10noxlhcoim2****-db-1
    BackupEndTime

    string

    The completion time of the backup.

    2019-03-14T05:31:13Z
    BackupId

    integer

    The ID of the backup set.

    165*****50
    BackupDBNames

    string

    The backed-up databases. A value of all indicates that all databases were backed up.

    all
    EngineVersion

    string

    The engine version of the instance. It specifies the compatible Redis version.

    4.0
    BackupIntranetDownloadURL

    string

    The internal download URL of the backup set.

    Note

    You can use this URL to download the backup set from an ECS instance that is in the same VPC as the database instance.

    https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
    BackupSize

    integer

    The size of the backup set, in bytes.

    1024
    BackupMode

    string

    The backup mode. Valid values:

    • Automated: An automated backup.

    • Manual: A manual backup.

    Automated
    BackupMethod

    string

    The backup method. Valid values:

    • Logical: A logical backup.

    • Physical: A physical backup.

    Physical
    BackupJobID

    integer

    The ID of the backup job.

    24340
    RecoverConfigMode

    string

    Indicates whether the backup set includes configuration information such as accounts (account), kernel parameters (config), and allowlists (whitelist).

    Note

    This parameter is available only for Cloud Native Edition instances. If you modify these settings, for example, create an account or add an IP address to an allowlist, the updated information is automatically included in subsequent backup sets.

    {"whitelist":true,"config":true,"account":true}
    ExpectExpireTime

    string

    The expiration time of the backup set. The time is in UTC and uses the yyyy-MM-ddTHH:mm:ssZ format.

    2025-06-01T21:51:22Z
    AccessDeniedDetail

    object

    This parameter is deprecated.

    AuthAction

    string

    This parameter is deprecated.

    -
    AuthPrincipalDisplayName

    string

    This parameter is deprecated.

    -
    AuthPrincipalOwnerId

    string

    This parameter is deprecated.

    -
    AuthPrincipalType

    string

    This parameter is deprecated.

    -
    EncodedDiagnosticMessage

    string

    This parameter is deprecated.

    -
    NoPermissionType

    string

    This parameter is deprecated.

    -
    PolicyType

    string

    This parameter is deprecated.

    -

    Examples

    Success response

    JSON format

    {
  "RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 5,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupStartTime": "2019-03-14T05:28:50Z",
        "BackupType": "FullBackup",
        "BackupDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "NodeInstanceId": "r-bp10noxlhcoim2****-db-1",
        "BackupEndTime": "2019-03-14T05:31:13Z",
        "BackupId": 0,
        "BackupDBNames": "all",
        "EngineVersion": "4.0",
        "BackupIntranetDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "BackupSize": 1024,
        "BackupMode": "Automated",
        "BackupMethod": "Physical",
        "BackupJobID": 24340,
        "RecoverConfigMode": "{\"whitelist\":true,\"config\":true,\"account\":true}",
        "ExpectExpireTime": "2025-06-01T21:51:22Z"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidStartTime.Malformed The Specified parameter StartTime is not valid.
    400 InvalidEndTime.Malformed The Specified parameter EndTime is not valid.
    400 InvalidEngineVersion.Malformed The Specified EngieVersion is not valid.
    400 InvalidStartTimeAndEndTime.Malformed The end time must be greater than the start time. The end time must be later than the start time.
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.