tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for Redis®
    Documentation
    Download PDF

    ModifyBackupDownloadRestriction

    Last updated: 2024-12-04 11:19:36
    Download PDF

      1. API Description

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

      This API is used to modify the network information and address for downloading a backup file.

      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: 2018-04-12.
      Region Yes String Common Params. For more information, please see the list of regions supported by the product.
      LimitType Yes 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 No String Only In can be passed in for this parameter, indicating that backup files can be downloaded in the custom LimitVpc.
      IpComparisonSymbol No 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.N No Array of BackupLimitVpcItem VPC ID of the custom backup file download address, which is required if LimitType is Customize.
      LimitIp.N No Array of String VPC IP of the custom backup file download address, which is required if LimitType is Customize.

      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 download address for a backup file

      This example shows you how to modify the custom network and address of a backup file in the current region.

      Input Example

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

{
    "LimitType": "Customize",
    "VpcComparisonSymbol": "In",
    "IpComparisonSymbol": "NotIn",
    "LimitVpc": [
        {
            "VpcList": [
                "vpc-5og4fwm9",
                "vpc-03dsikyx"
            ],
            "Region": "ap-guangzhou"
        }
    ],
    "LimitIp": [
        "10.1.0.13"
    ]
}

      Output Example

      {
    "Response": {
        "RequestId": "489f7bc7-e0e0-4e6f-a5c4-97c5fcf7ea8b"
    }
}

      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.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.
      InvalidParameter.InvalidParameter Invalid service parameter.
      InvalidParameter.PermissionDenied The API has no CAM permissions.
      UnauthorizedOperation.NoCAMAuthed No CAM permissions.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy