All Products
Search
Document Center

Tair:DescribeBackups

Last Updated:May 28, 2024

Queries the backup files of the ApsaraDB for Redis instance.

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
kvstore:DescribeBackupsRead
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance whose backup files you want to query.

r-bp1zxszhcgatnx****
BackupIdintegerNo

The ID of the backup file.

11611111
PageSizeintegerNo

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

30
PageNumberintegerNo

The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.

1
StartTimestringYes

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.

2019-03-11T10:00Z
EndTimestringYes

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

2019-03-14T18:00Z
NeedAofstringNo

Specifies whether to enable append-only files (AOFs) persistence. Valid values:

  • 0: no
  • 1: yes
Note The default value is 0.
1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The page number of the returned page.

1
PageSizeinteger

The number of entries returned on each page.

30
TotalCountinteger

The total number of backup files that were returned.

5
FullStorageSizelong

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

Note The value of this parameter is independent of the number and size of the returned backup sets. Instead, it reflects the total size of all valid full backups of the instance.
1000
LogStorageSizelong

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

Note The value of this parameter is independent of the number and size of the returned backup sets. Instead, it reflects the total size of all valid log backups of the instance.
5000
FreeSizelong

This parameter does not take effect. Ignore this parameter.

100000
Backupsobject []

Details of the backup files.

BackupStatusstring

The status of the backup. Valid values:

  • Success
  • Failed
Success
BackupStartTimestring

The start time of the backup.

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

The backup type. Valid values:

  • FullBackup
  • IncrementalBackup
FullBackup
BackupDownloadURLstring

The public download URL of the backup file.

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

The node ID.

Note If the instance uses the standard architecture, this parameter returns the instance ID.
r-bp10noxlhcoim2****-db-1
BackupEndTimestring

The end time of the backup.

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

The ID of the backup file.

165*****50
BackupDBNamesstring

The names of the databases that are backed up. The default value is all, which indicates that all databases are backed up.

all
EngineVersionstring

The engine version (major version) of the instance.

4.0
BackupIntranetDownloadURLstring

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 ApsaraDB for Redis instance. The ECS instance must belong to the same classic network or reside in the same virtual private cloud (VPC) as the ApsaraDB for Redis instance.
https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
BackupSizelong

The size of the backup file.

1024
BackupModestring

The backup mode. Valid values:

  • Automated
  • Manual
Automated
BackupMethodstring

The backup method. Valid values:

  • Logical
  • Physical
Physical
BackupJobIDinteger

The ID of the backup task.

24340
AccessDeniedDetailobject

The following parameters are no longer used. Ignore the parameters.

AuthActionstring

This parameter is no longer used. Ignore this parameter.

_
AuthPrincipalDisplayNamestring

This parameter is no longer used. Ignore this parameter.

_
AuthPrincipalOwnerIdstring

This parameter is no longer used. Ignore this parameter.

_
AuthPrincipalTypestring

This parameter is no longer used. Ignore this parameter.

_
EncodedDiagnosticMessagestring

This parameter is no longer used. Ignore this parameter.

_
NoPermissionTypestring

This parameter is no longer used. Ignore this parameter.

_
PolicyTypestring

This parameter is no longer used. Ignore this parameter.

_

Examples

Sample success responses

JSONformat

{
  "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
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "_",
    "AuthPrincipalDisplayName": "_",
    "AuthPrincipalOwnerId": "_",
    "AuthPrincipalType": "_",
    "EncodedDiagnosticMessage": "_",
    "NoPermissionType": "_",
    "PolicyType": "_"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.MalformedThe Specified parameter StartTime is not valid.-
400InvalidEndTime.MalformedThe Specified parameter EndTime is not valid.The end time is invalid. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Example: 2011-06-11T16:00Z.
400InvalidEngineVersion.MalformedThe Specified EngieVersion is not valid.-
400InvalidStartTimeAndEndTime.MalformedThe end time must be greater than the start time.The end time must be later than the start time.
400InvalidPageSize.MalformedThe specified parameter PageSize is not valid.-

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

Change history

Change timeSummary of changesOperation
2024-05-23The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2024-05-06The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2024-03-26The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2024-01-22The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2024-01-03The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: BackupJobId
2023-11-13The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2023-11-06The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2023-07-25API Description Update. The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2022-11-29The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.