DescribeBackupDownloadRestriction

Last updated: 2021-11-24 16:53:46

1. API Description

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

This API is used to query the restrictions of downloading backups in a region.

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 parameter. The value used for this API: DescribeBackupDownloadRestriction.
Version Yes String Common parameter. The value used for this API: 2017-03-20.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.

3. Output Parameters

Parameter Name Type Description
LimitType 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 String Valid value: In (backups can only be downloaded over the VPCs specified in LimitVpc).
IpComparisonSymbol 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).
LimitVpc Array of BackupLimitVpcItem VPCs used to restrict backup download.
LimitIp Array of String IPs used to restrict backup download.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying backup download restrictions

Input Example

https://cdb.tencentcloudapi.com/?Action=DescribeBackupDownloadRestriction
&<Common request parameters>

Output Example

{
  "Response": {
    "IpComparisonSymbol": "NotIn",
    "LimitIp": [
      "1.2.3.4",
      "192.168.10.0/24"
    ],
    "LimitType": "Customize",
    "LimitVpc": [
      {
        "Region": "ap-guangzhou",
        "VpcList": [
          "vpc-aa3ximox",
          "vpc-64elqxc9"
        ]
      }
    ],
    "RequestId": "b0439fbf-f835-4327-bed8-184d48ef43db",
    "VpcComparisonSymbol": "In"
  }
}

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