Last updated: 2020-09-10 18:01:36

1. API Description

Domain name for API request:

This API is used to query the download address of a backup RDB (it is during beta test and can be used only after you apply for the eligibility).

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example:

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeBackupUrl.
Version Yes String Common parameter. The value used for this API: 2018-04-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID
BackupId Yes String Backup ID, which can be queried through the DescribeInstanceBackups API

3. Output Parameters

Parameter Name Type Description
DownloadUrl Array of String Download address on the public network (valid for 6 hours)
InnerDownloadUrl Array of String Download address on the private network (valid for 6 hours)
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the download address of an RDB backup

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "DownloadUrl": [
    "InnerDownloadUrl": [
    "RequestId": "f1b5aabe-806a-4886-b839-9907baa24c85"

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
InternalError.InternalError Internal error.
InvalidParameter.PermissionDenied The API has no CAM permissions.
InvalidParameterValue.BackupNotExists The backup does not exist.
ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
UnauthorizedOperation.UserNotInWhiteList The user is not in the allowlist.
UnsupportedOperation.ClusterInstanceAccessedDeny The Redis cluster edition is not allowed to connect to a security group.
UnsupportedOperation.IsAutoRenewError Auto-renewal flag error.
UnsupportedOperation.OnlyClusterInstanceCanExportBackup Only cluster edition instances support backup exporting.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback