tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyBackupDownloadRestriction

Last updated: 2024-11-20 11:15:42

    1. API Description

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

    This API is used to modify the restrictions of downloading backups in a region. You can specify which types of networks (private, or both private and public), VPCs, and IPs to download backups.

    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-20.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    LimitType Yes String Valid values: NoLimit (backups can be downloaded over both private and public networks with any IPs), LimitOnlyIntranet (backups can be downloaded over the private network with any private IPs), Customize (backups can be downloaded over specified VPCs with specified IPs). The LimitVpc and LimitIp parameters are valid only when this parameter is set to Customize.
    VpcComparisonSymbol No String Valid value: In (backups can only be downloaded over the VPCs specified in LimitVpc). Default value: In.
    IpComparisonSymbol No String Valid values: In (backups can only be downloaded with the IPs specified in LimitIp), NotIn (backups cannot be downloaded with the IPs specified in LimitIp). Default value: In.
    LimitVpc.N No Array of BackupLimitVpcItem VPCs used to restrict backup download.
    LimitIp.N No Array of String IPs used to restrict backup download.

    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 backup download restrictions

    Input Example

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

{
    "LimitType": "Customize",
    "VpcComparisonSymbol": "In",
    "LimitVpc": [
        {
            "Region": "ap-guangzhou",
            "VpcList": [
                "vpc-64elqxc9",
                "vpc-aa3ximox"
            ]
        }
    ],
    "IpComparisonSymbol": "NotIn",
    "LimitIp": [
        "192.168.10.0/24",
        "1.2.3.4"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "7fd6ee14-ad09-4c58-9612-65d4d1691d50"
    }
}

    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
    InternalError.AuthError Authentication failed.
    InternalError.DBError Database exception
    InternalError.HttpError Exceptional HTTP request
    InternalError.UnknownError Unknown error
    InvalidParameter.ExceptionParam Parameter exception.
    InvalidParameterValue.DataConvertError Data conversion failed.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy