Release Notes
Announcements
Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to query the download address for a database backup file in the current region.
A maximum of 20 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: DescribeBackupDownloadRestriction. |
| Version | Yes | String | Common Params. The value used for this API: 2018-04-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Parameter Name | Type | Description |
|---|---|---|
| LimitType | String | Type of the network restrictions for downloading backup files. Valid values: - NoLimit: Backup files can be downloaded over both public and private networks.- LimitOnlyIntranet: Backup files can be downloaded only at private network addresses auto-assigned by Tencent Cloud.- Customize: Backup files can be downloaded only in the customized VPC. |
| VpcComparisonSymbol | String | Only In can be passed in for this parameter, indicating that backup files can be downloaded in the custom LimitVpc. |
| IpComparisonSymbol | String | Whether backups can be downloaded at the custom LimitIp address.- In: Download is allowed for the custom IP.- NotIn: Download is not allowed for the custom IP. |
| LimitVpc | Array of BackupLimitVpcItem | VPC ID of the custom backup file download address, which will be displayed if LimitType is Customize. |
| LimitIp | Array of String | Custom VPC IP address for downloading backup files. This parameter is displayed when the LimitType parameter is set to Customize. |
| 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 query the restrictions for downloading a backup file in the current region.
POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupDownloadRestriction
<Common request parameters>
{}{
"Response": {
"IpComparisonSymbol": "NotIn",
"LimitIp": [
"10.1.0.13"
],
"LimitType": "Customize",
"LimitVpc": [
{
"Region": "ap-guangzhou",
"VpcList": [
"vpc-5og4fwm9",
"vpc-03dsikyx"
]
}
],
"RequestId": "785b6c5f-999f-43ef-9906-14f4c24b8040",
"VpcComparisonSymbol": "In"
}
}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.SystemError | Internal system error, which is irrelevant to the business. |
| InternalError.DbOperationFailed | Internal system error with the database operation, which may be update, insert, select, etc. |
| InternalError.InternalError | Internal error. |
| InvalidParameter.PermissionDenied | The API has no CAM permissions. |
| UnauthorizedOperation.NoCAMAuthed | No CAM permissions. |
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