Domain name for API request: postgres.intl.tencentcloudapi.com.
u200cThis API is used to query the download address of a specified backup set, including full backup sets and incremental log backup sets.
A maximum of 1000 requests can be initiated per second for this API.
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 Params. The value used for this API: DescribeBackupDownloadURL. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| DBInstanceId | Yes | String | Instance ID. obtain through the api DescribeDBInstances. |
| BackupType | Yes | String | Backup type. Valid values: LogBackup, BaseBackup. |
| BackupId | Yes | String | Unique backup ID. |
| URLExpireTime | No | Integer | Validity time of the connection. value range: [0,36]. default value: 12 hours. |
| BackupDownloadRestriction | No | BackupDownloadRestriction | Backup download restriction |
| Parameter Name | Type | Description |
|---|---|---|
| BackupDownloadURL | String | Backup download URL |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to obtain the backup download link.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupDownloadURL
<Common request parameters>
{
"DBInstanceId": "postgres-oamgybor",
"BackupType": "LogBackup",
"BackupId": "f9509fc2-2281-551c-b937-86d38cf79f3b",
"URLExpireTime": 12
}
{
"Response": {
"BackupDownloadURL": "https://postgres-backup-gz-xxxx.cos.ap-guangzhou.myqcloud.com/pgsql/xxxx",
"RequestId": "7c4e788e-5ec9-4125-bb80-7baabe2744dc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.DatabaseAccessError | Failed to access database management service. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.FailedOperationError | Operation failed. Please try again later. |
| InternalError.InstanceDataError | Failed to access database management service. Please contact customer service. |
| InvalidParameterValue.InvalidParameterValueError | Incorrect parameter value |
| InvalidParameterValue.ParameterValueExceedError | The maximum value of the parameter has been reached. |
| OperationDenied.CamDeniedError | This operation cannot be performed. |
| OperationDenied.InstanceStatusLimitError | This operation cannot be performed on an instance in this status. |
| ResourceNotFound.InstanceNotFoundError | The instance does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback