DescribeBackups - Tair - Alibaba Cloud Documentation Center

Queries the backup files of an ApsaraDB for Redis instance.

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.

Operation	Access level	Resource type	Condition key	Association operation
kvstore:DescribeBackups	READ	Redis acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance whose backup files you want to query.	r-bp1zxszhcgatnx****
BackupId	integer	No	The ID of the backup file.	11611111
PageSize	integer	No	The number of entries to return on each page. Valid values: 30, 50, 100, 200, and 300.	30
PageNumber	integer	No	The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.	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.	2019-03-11T10:00Z
EndTime	string	Yes	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
NeedAof	string	No	Specifies whether to enable append-only files (AOFs) persistence. Valid values: 0: no 1: yes NoteThe default value is 0.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	963C20F0-7CE1-4591-AAF3-6F3CD1CE****
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned on each page.	30
TotalCount	integer	The total number of backup files that were returned.	5
Backups	array	Details of the backup files.
	object
BackupStatus	string	The state of the backup task. Valid values: Success: The task is successful. Failed: The task failed.	Success
BackupStartTime	string	The start time of the backup.	2019-03-14T05:28:50Z
BackupType	string	The backup type of the backup file. Valid values: FullBackup IncrementalBackup	FullBackup
BackupDownloadURL	string	The public download URL of the backup file.	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
NodeInstanceId	string	The node ID. NoteIf a standard instance is used, the instance ID is returned.	r-bp10noxlhcoim2****-db-1
BackupEndTime	string	The end time of the backup.	2019-03-14T05:31:13Z
BackupId	integer	The ID of the backup file.	111111111
BackupDBNames	string	The databases that are backed up. Default value: all, which indicates that all databases are backed up.	all
EngineVersion	string	The major engine version of the instance.	4.0
BackupIntranetDownloadURL	string	The internal download URL of the backup file. NoteYou can download the backup file by using this URL from the Elastic Compute Service (ECS) instance that is connected to the ApsaraDB for Redis instance. The ECS instance and ApsaraDB for Redis instance must reside in the classic network or the same virtual private cloud (VPC) within the same region.	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
BackupSize	long	The size of the backup file.	1024
BackupMode	string	The backup mode. Valid values: Automated Manual	Automated
BackupMethod	string	The backup method. Valid values: Logical Physical	Physical
BackupJobID	integer	The ID of the backup task.	24340

Examples

Sample success responses

JSONformat

{
  "RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 5,
  "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": 111111111,
        "BackupDBNames": "all",
        "EngineVersion": "4.0",
        "BackupIntranetDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "BackupSize": 1024,
        "BackupMode": "Automated",
        "BackupMethod": "Physical",
        "BackupJobID": 24340
      }
    ]
  }
}

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.	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.
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.	-

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

Change history

Change time

Summary of changes

Operation

2022-11-29

The error codes of the API operation change.,The response structure of the API operation changes.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.