tencent cloud

TencentDB for PostgreSQL

ModifyBackupDownloadRestriction

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-05-21 10:44:17

1. API Description

Domain name for API request: postgres.intl.tencentcloudapi.com.

This API is used to modify the backup download restrictions.

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

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 Params. The value used for this API: ModifyBackupDownloadRestriction.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
RestrictionType Yes String Backup file download restriction type. valid values: NONE (unlimited, allows download from both private and public networks), INTRANET (only allows private network download), CUSTOMIZE (custom limits for download by vpc or ip). when the parameter value is CUSTOMIZE, at least one item must be filled in for vpc restriction and ip restriction.
VpcRestrictionEffect No String Whether VPC is allowed. Valid values: ALLOW (allow), DENY (deny).
VpcIdSet.N No Array of String Specifies the vpc id list to allow or deny downloading backup files.
Note: This input parameter performs a full replacement on all existing collections but not an incremental update. To modify it, import the expected full collections.
IpRestrictionEffect No String Whether IP is allowed. Valid values: ALLOW (allow), DENY (deny).
IpSet.N No Array of String Specifies the ip list to allow or deny downloading backup files.
Note: This input parameter performs a full replacement on all existing collections but not an incremental update. To modify it, import the expected full collections.

3. Output Parameters

Parameter Name Type Description
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.

4. Example

Example1 Modifying the Backup Download Limit

This example shows you how to modify the backup download limit.

Input Example

POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBackupDownloadRestriction
<Common request parameters>

{
    "RestrictionType": "CUSTOMIZE",
    "VpcRestrictionEffect": "ALLOW",
    "VpcIdSet": [
        "vpc-15ld6dhr"
    ],
    "IpRestrictionEffect": "ALLOW",
    "IpSet": [
        "10.*.*.*"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "be3bafde-f34e-4fda-9f40-04c5515e2148"
    }
}

5. Developer Resources

SDK

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.DatabaseAffectedError Data operation failed. Please contact customer service.
FailedOperation.FailedOperationError Operation failed. Please try again later.
InvalidParameter.ParameterCheckError Failed to check the parameter.
InvalidParameter.VpcNotFoundError Failed to query VPC information.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
OperationDenied.CamDeniedError This operation cannot be performed.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백