DocsICP FilingConsole
Documentation

DescribeBackups

Updated at:
Copy as MD
Product
My Favorites

Queries the backup file information of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance.

Operation description

This operation is not applicable to cloud-native cluster architecture instances. If needed, 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 instance ID.

r-bp1zxszhcgatnx****
BackupId

integer

No

The ID of the backup file.

11611111
BackupJobId

integer

No

The ID of the backup job. This ID is returned by the CreateBackup operation. If CreateBackup returns multiple BackupJobIds, you must call this operation to query each of them separately.

10001
PageSize

integer

No

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

Valid values:

  • 30 :

    30 entries per page.

  • 50 :

    50 entries per page.

  • 100 :

    100 entries per page.

  • 200 :

    200 entries per page.

  • 300 :

    300 entries per page.

30
PageNumber

integer

No

The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. Default value: 1.

1
StartTime

string

Yes

The start time of the query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2019-03-11T10:00Z
EndTime

string

Yes

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

2019-03-14T18:00Z
NeedAof

string

No

Specifies whether to enable AOF persistence. Valid values:

  • 0: Disabled.

  • 1: Enabled.

Note

Default value: 0.

1

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

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

integer

The page number.

1
PageSize

integer

The maximum number of entries per page.

30
TotalCount

integer

The total number of backups.

5
FullStorageSize

integer

The size of full backup files for the current instance. Unit: bytes. Full backups include daily scheduled backups, manual backups, and backups generated during cache analysis.

Note

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

1000
LogStorageSize

integer

The size of instance log backup files for the current instance. Unit: bytes. This value is valid only when the flashback feature is enabled.

Note

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

5000
FreeSize

integer

The free backup quota for the instance. Unit: bytes. The free quota is equal to the default memory capacity of the instance type. For more information, see Notice on backup commercialization. Full backups and log backups share this free quota. When you change the instance type, the free quota of the instance changes accordingly.

100000
Backups

object

Backup

array<object>

The details of the backup set.

object

The details of the backup set.

BackupStatus

string

The backup status. Valid values:

  • Success: The backup succeeded.

  • Failed: The backup failed.

Success
BackupStartTime

string

The start time of the backup.

The time is in the YYYY-MM-DDTHH:mm:ssZ format and displayed in UTC.

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

string

The backup type. Valid values:

  • FullBackup: Full backup.

  • IncrementalBackup: Incremental backup.

FullBackup
BackupDownloadURL

string

The public URL for downloading the backup file.

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

string

The node ID.

Note

If the instance uses the standard architecture, this parameter returns the instance ID.

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

string

The end time of the backup.

The time is in the YYYY-MM-DDTHH:mm:ssZ format and displayed in UTC.

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

integer

The ID of the backup file.

165*****50
BackupDBNames

string

The databases that are backed up. Default value: all, which indicates that all databases are backed up.

all
EngineVersion

string

The database engine version, which is the version of the DPI engine that is compatible with Redis on the instance.

4.0
BackupIntranetDownloadURL

string

The internal URL for downloading the backup file.

Note

You can use this URL to download the backup file from an ECS instance that is connected to the Tair instance. Both instances must reside in the same VPC.

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

integer

The size of the backup file.

1024
BackupMode

string

The backup mode. Valid values:

  • Automated: Automatic backup.

  • Manual: Manual backup.

Automated
BackupMethod

string

The backup method. Valid values:

  • Logical: Logical backup.

  • Physical: Physical backup.

Physical
BackupJobID

integer

The ID of the backup job.

24340
RecoverConfigMode

string

Indicates whether the backup set contains account, kernel parameter, and whitelist information.

Note

This parameter is applicable only to cloud-native instances. If you modify the preceding information of the instance, such as creating an account or adding a whitelist, the modified information is included in subsequent backup sets through automatic backup.

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

string

The expiration time of the backup set. The time is in the yyyy-MM-ddTHH:mmZ format and displayed in UTC.

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

object

This group of parameters is deprecated. Ignore it.

AuthAction

string

See the preceding description.

-
AuthPrincipalDisplayName

string

See the preceding description.

-
AuthPrincipalOwnerId

string

See the preceding description.

-
AuthPrincipalType

string

See the preceding description.

-
EncodedDiagnosticMessage

string

See the preceding description.

-
NoPermissionType

string

See the preceding description.

-
PolicyType

string

See the preceding description.

-

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.