tencent cloud



Last updated: 2022-08-17 15:58:28

1. API Description

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

This API is used to create a database proxy group for a source instance.

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: ApplyCDBProxy.
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.
InstanceId Yes String Unique ID of the source instance
UniqVpcId Yes String VPC ID
UniqSubnetId Yes String VPC subnet ID
ProxyCount Yes Integer Number of nodes in the proxy group
Cpu Yes Integer Number of CPU cores
Mem Yes Integer Memory
SecurityGroup.N No Array of String Security group
Desc No String Description (up to 256 characters)

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Async request ID
Note: this field may return null, indicating that no valid value can be found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a database proxy

Input Example

Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplyCDBProxy
<Common request parameters>

    "UniqVpcId": "xx",
    "InstanceId": "xx",
    "SecurityGroup": [
    "Mem": 1,
    "UniqSubnetId": "xx",
    "Desc": "xx",
    "Cpu": 1,
    "ProxyCount": 1

Output Example

    "Response": {
        "AsyncRequestId": "dd803e8b-02543d6b-0b6ec9c4-8c1e133c",
        "RequestId": "6236a2ad-0557-48c3-b983-247d2870e0a1"

5. Developer Resources


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.RepeatCreateProxyError The proxy is being created or already exists. You cannot create it again.
InternalError.UnknownError Unknown error
Contact Us

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

Technical Support

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

7x24 Phone Support