All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeClusterBackupList

    Document Center

    Tair (Redis® OSS-Compatible):DescribeClusterBackupList

    Last Updated:Aug 28, 2026

    Queries the backup list of a Tair (Redis OSS-compatible) cluster instance.

    Operation description

    This operation applies only to cloud-native instances.

    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:DescribeClusterBackupList

    get

    *DBInstance

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

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

    cn-zhangjiakou
    InstanceId

    string

    Yes

    The instance ID.

    r-t4nj72oug5r5646qog
    ClusterBackupId

    string

    No

    The backup set ID.

    cb-hyxdof5x9kqbtust

    PageSize

    integer

    No

    The number of entries per page.

    Valid values:

    • 30

    • 50

    • 100

    • 200

    • 300

    • 5

    • 10

    • 15

    • 20

    30
    PageNumber

    integer

    No

    The page number.

    1
    StartTime

    string

    Yes

    The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

    2024-06-28T08:26Z
    EndTime

    string

    Yes

    The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later than the start time.

    2024-07-01T09:26Z
    NoShardBackup

    string

    No

    Specifies whether to include backup set information for individual shards.

    • true: excludes shard-level backup set information.

    • false (default): includes shard-level backup set information.

    Valid values:

    • True

    • False

    True

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    C009DA42-3B19-5B81-963D-1509DE2408DD
    MaxResults

    integer

    The maximum number of entries returned.

    4
    PageNumber

    integer

    The page number.

    1
    PageSize

    integer

    The maximum number of entries returned per page.

    30
    FullStorageSize

    integer

    The size of the full backup file. Unit: bytes. Full backups originate from scheduled backups, manual backups, and backups generated during cache analysis.

    Note

    This value is independent of the number and size of returned backup sets. It represents the total size of all valid full backups for the instance.

    1000
    LogStorageSize

    integer

    The size of the log backup file. Unit: bytes. This parameter is valid only when flashback is enabled.

    Note

    This value is independent of the number and size of returned backup sets. It represents the total size of all valid log backups for the instance.

    5000
    FreeSize

    integer

    This parameter does not take effect. Ignore this parameter.

    100000
    ClusterBackups

    array<object>

    The backup sets of the instance. Each backup contains the backup sets of all shards.

    array<object>

    Details of a single backup, including the backup sets of all shards.

    IsAvail

    integer

    Indicates whether the backup set is valid. A value of 0 means that shard-level backups failed or are incomplete.

    1
    ClusterBackupId

    string

    The ID of the backup set.

    cb-zmdqj2m3xyxjtdt0
    ClusterBackupStatus

    string

    The status of the backup set.

    • OK

    • RUNNING

    • Failed

    OK
    ClusterBackupSize

    string

    The size of the backup set.

    2048
    ClusterBackupStartTime

    string

    The start time of the backup.

    2024-01-10T17:21:25Z
    ClusterBackupEndTime

    string

    The end time of the backup.

    2024-01-10T17:21:55Z
    ClusterBackupMode

    string

    The backup mode.

    Automated
    ShardClassMemory

    integer

    The memory size of a single shard during a full backup. Unit: MB.

    1024
    Backups

    array<object>

    The backup sets of all shards in the instance.

    array<object>

    The queried backup set.

    BackupId

    string

    The ID of the backup file.

    514645788
    InstanceName

    string

    The instance name.

    r-bp1y4is8svonly****-db-0
    BackupDownloadURL

    string

    The public download URL of the backup file.

    http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
    BackupIntranetDownloadURL

    string

    The internal download URL of the backup file.

    Note

    You can use this URL to download the backup file from an Elastic Compute Service (ECS) instance that is connected to the Tair (Redis OSS-compatible) instance. The ECS instance must reside in the same virtual private cloud (VPC) as the Tair (Redis OSS-compatible) instance.

    http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
    RecoverConfigMode

    string

    This parameter does not take effect. Ignore this parameter.

    null
    BackupStartTime

    string

    The start time of the backup. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    2024-01-09T17:21:30Z
    BackupEndTime

    string

    The end time of the backup. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    2024-01-09T17:21:57
    BackupSize

    string

    The size of the backup file. Unit: bytes.

    1024
    IsAvail

    string

    Indicates whether the backup set is available. Valid values:

    • 0: unavailable

    • 1: available

    1
    BackupStatus

    string

    The status of the backup. Valid values:

    • OK

    • ERROR

    OK
    BackupName

    string

    The name of the backup.

    hins100322105_data_20240110012135.rdb
    Engine

    string

    The return value is redis.

    redis
    ExtraInfo

    object

    The additional information.

    CustinsDbVersion

    string

    The engine version.

    5.0
    Progress

    string

    The backup progress. Only running backup tasks display progress.

    100%
    ExpectExpireTime

    string

    The expiration time of the backup set, in the format yyyy-MM-ddTHH:mmZ (UTC time).

    2025-06-01T21:51:22Z

    Examples

    Success response

    JSON format

    {
  "RequestId": "C009DA42-3B19-5B81-963D-1509DE2408DD",
  "MaxResults": 4,
  "PageNumber": 1,
  "PageSize": 30,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "ClusterBackups": [
    {
      "IsAvail": 1,
      "ClusterBackupId": "cb-zmdqj2m3xyxjtdt0",
      "ClusterBackupStatus": "OK",
      "ClusterBackupSize": "2048",
      "ClusterBackupStartTime": "2024-01-10T17:21:25Z",
      "ClusterBackupEndTime": "2024-01-10T17:21:55Z",
      "ClusterBackupMode": "Automated",
      "ShardClassMemory": 1024,
      "Backups": [
        {
          "BackupId": "514645788",
          "InstanceName": "r-bp1y4is8svonly****-db-0",
          "BackupDownloadURL": "http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb",
          "BackupIntranetDownloadURL": "http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb",
          "RecoverConfigMode": "null",
          "BackupStartTime": "2024-01-09T17:21:30Z",
          "BackupEndTime": "2024-01-09T17:21:57",
          "BackupSize": "1024",
          "IsAvail": "1",
          "BackupStatus": "OK",
          "BackupName": "hins100322105_data_20240110012135.rdb",
          "Engine": "redis",
          "ExtraInfo": {
            "CustinsDbVersion": "5.0"
          }
        }
      ],
      "Progress": "100%",
      "ExpectExpireTime": "2025-06-01T21:51:22Z"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.