Queries the backup files of an 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeBackups

The operation that you want to perform. Set the value to DescribeBackups.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance.

StartTime String Yes 2019-03-11T10:00Z

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.

EndTime String Yes 2019-03-14T18:00Z

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.

BackupId Integer No 11611111

The ID of the backup file.

PageNumber Integer No 1

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

PageSize Integer No 30

The maximum number of entries to return on each page.

NeedAof String No 1

Specifies whether to enable AOF. Valid values:

  • 0: No.
  • 1: Yes.
Note Default value: 0.
RegionId String No cn-hangzhou

The ID of the region where the instance is deployed.

Response parameters

Parameter Type Example Description
TotalCount Integer 5

The total number of backup files that were returned.

PageNumber Integer 1

The page number of the returned page.

Backups Array of Backup

The details of the backup set.

Backup
BackupDBNames String all

The database to be backed up. The default value is all, which indicates that all databases are backed up.

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

The public download URL of the backup file.

BackupEndTime String 2019-03-14T05:31:13Z

The time when the backup ended.

BackupId Integer 111111111

The ID of the backup file.

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

The internal download URL of the backup file.

Note You can download the backup file by using this URL in the Elastic Compute Service (ECS) instance that is connected to the ApsaraDB for Redis instance. The ECS instance and ApsaraDB for Redis instance must be in the classic network of the same region or in the same virtual private cloud (VPC).
BackupMethod String Physical

The backup method. Valid values:

  • Logical
  • Physical
BackupMode String Automated

The backup mode. Valid values:

  • Automated
  • Manual
BackupSize Long 1024

The size of the backup file.

BackupStartTime String 2019-03-14T05:28:50Z

The time when the backup started.

BackupStatus String Success

The status of the backup task. Valid values:

  • Success: The backup was successful.
  • Failed: The backup failed.
BackupType String FullBackup

The backup type. Valid values:

  • FullBackup: full backup.
  • IncrementalBackup: incremental backup.
EngineVersion String 4.0

The engine version (major version) of the instance.

NodeInstanceId String r-bp10noxlhcoim2****-db-1

The ID of the node.

Note If a standard instance is used, the instance ID is returned.
PageSize Integer 30

The maximum number of entries returned per page.

RequestId String 963C20F0-7CE1-4591-AAF3-6F3CD1CE****

The ID of the request.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=DescribeBackups
&InstanceId=r-bp1zxszhcgatnx****
&StartTime=2019-03-11T10:00Z
&EndTime=2019-03-14T18:00Z
&<Common request parameters>

Sample success responses

XML format

<DescribeBackupsResponse>
      <TotalCount>1</TotalCount>
      <RequestId>721E2D39-351D-40E2-BF7C-B5075B0A****</RequestId>
      <PageSize>30</PageSize>
      <PageNumber>1</PageNumber>
      <Backups>
            <Backup>
                  <BackupMethod>Physical</BackupMethod>
                  <EngineVersion>4.0</EngineVersion>
                  <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/********</BackupIntranetDownloadURL>
                  <BackupMode>Automated</BackupMode>
                  <BackupSize>2263040</BackupSize>
                  <BackupId>775661111</BackupId>
                  <NodeInstanceId>r-bp12fdcf4dea****</NodeInstanceId>
                  <BackupDBNames>all</BackupDBNames>
                  <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/********</BackupDownloadURL>
                  <BackupEndTime>2020-10-30T17:31:26Z</BackupEndTime>
                  <BackupStartTime>2020-10-30T17:28:28Z</BackupStartTime>
                  <BackupType>FullBackup</BackupType>
                  <BackupStatus>Success</BackupStatus>
            </Backup>
      </Backups>
</DescribeBackupsResponse>

JSON format

{
	"TotalCount": 1,
	"RequestId": "721E2D39-351D-40E2-BF7C-B5075B0A****",
	"PageSize": 30,
	"PageNumber": 1,
	"Backups": {
		"Backup": [
			{
				"BackupMethod": "Physical",
				"EngineVersion": "4.0",
				"BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/********",
				"BackupMode": "Automated",
				"BackupSize": 2263040,
				"BackupId": 775661111,
				"NodeInstanceId": "r-bp12fdcf4dea****",
				"BackupDBNames": "all",
				"BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/********",
				"BackupEndTime": "2020-10-30T17:31:26Z",
				"BackupStartTime": "2020-10-30T17:28:28Z",
				"BackupType": "FullBackup",
				"BackupStatus": "Success"
			}
		]
	}
}

Error codes

HttpCode Error code Error message Description
400 InvalidEndTime.Malformed The Specified parameter EndTime is not valid. The error message returned because the format of the end time is invalid. The time must be in GMT. Example: 2011-06-11T16:00Z.

For a list of error codes, visit the API Error Center.