Domain name for API request: postgres.tencentcloudapi.com.
This API is used to query the backup download restrictions.
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: 2017-03-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
Parameter Name | Type | Description |
---|---|---|
RestrictionType | String | Type of the network restrictions for downloading a backup file. Valid values: NONE (backups can be downloaded over both private and public networks), INTRANET (backups can only be downloaded over the private network), CUSTOMIZE (backups can be downloaded over specified VPCs or at specified IPs). |
VpcRestrictionEffect | String | Whether VPC is allowed. Valid values: ALLOW (allow), DENY (deny). Note: This field may return null, indicating that no valid values can be obtained. |
VpcIdSet | Array of String | Whether it is allowed to download the VPC ID list of the backup files. Note: This field may return null, indicating that no valid values can be obtained. |
IpRestrictionEffect | String | Whether IP is allowed. Valid values: ALLOW (allow), DENY (deny). Note: Note: This field may return null, indicating that no valid values can be obtained. |
IpSet | Array of String | Whether it is allowed to download the IP list of the backup files. Note: This field may return null, indicating that no valid values can be obtained. |
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 backup download restrictions.
POST / HTTP/1.1Host: postgres.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeBackupDownloadRestriction<common request parameters>{}
{
"Response": {
"RestrictionType": "Customize",
"VpcRestrictionEffect": "Allow",
"VpcIdSet": [
"vpc-15ld6dhr"
],
"IpRestrictionEffect": "",
"IpSet": [],
"RequestId": "be3bafde-f34e-4fda-9f40-04c5515e2148"
}
}
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. |
OperationDenied.CamDeniedError | This operation cannot be performed. |
Was this page helpful?