tencent cloud

DescribeBackupDownloadRestriction
마지막 업데이트 시간:2025-11-13 20:51:48
DescribeBackupDownloadRestriction
마지막 업데이트 시간: 2025-11-13 20:51:48

1. API Description

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

This API is used to query the download source limit of the default backup configured by the user in the current 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 Params. The value used for this API: DescribeBackupDownloadRestriction.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterIds.N Yes Array of String Cluster ID

3. Output Parameters

Parameter Name Type Description
BackupLimitClusterRestrictions Array of BackupLimitClusterRestriction Cluster backup download limit.
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.

4. Example

Example1 Query Backup Download Limit

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

Input Example

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

{
    "ClusterIds": [
        "cynosdbmysql-2p3wjmzt"
    ]
}

Output Example

{
    "Response": {
        "BackupLimitClusterRestrictions": [
            {
                "BackupLimitRestriction": {
                    "IpComparisonSymbol": "In",
                    "LimitIps": [],
                    "LimitType": "Customize",
                    "LimitVpcs": [
                        {
                            "Region": "ap-guangzhou",
                            "VpcList": []
                        }
                    ],
                    "VpcComparisonSymbol": "In"
                },
                "ClusterId": "cynosdbmysql-2p3wjmzt"
            }
        ],
        "RequestId": "36eca298-c9b7-4e13-8f33-3c07926ee0d8"
    }
}

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.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FlowCreateError Failed to create a task. Try again later. If the problem persists, contact customer service.
FailedOperation.TradeCreateOrderError Failed to create the order and make a payment. Please try again later. If the problem persists, please contact customer service.
InternalError.DbOperationFailed Failed to query the database.
InternalError.UnknownError Unknown internal error.
InvalidParameterValue.ClusterNotFound No cluster found.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
InvalidParameterValue.InvalidRegionIdError The region is invalid.
OperationDenied.ClusterOpNotAllowedError The current cluster does not allow the operation.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
ResourceUnavailable.InstanceLockFail Failed to lock the instance, so the operation cannot be performed temporarily.
ResourceUnavailable.InstanceStatusAbnormal The instance is exceptional, so the operation cannot be performed temporarily.
UnauthorizedOperation.PermissionDenied CAM authentication failed.
문제 해결에 도움이 되었나요?
더 자세한 내용은 문의하기 또는 티켓 제출 을 통해 문의할 수 있습니다.
아니오

피드백