tencent cloud

All product documents
TencentDB for MySQL
CreateCdbProxy
Last updated: 2024-11-20 11:15:22
CreateCdbProxy
Last updated: 2024-11-20 11:15:22

1. API Description

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

This API is used create a database proxy 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: CreateCdbProxy.
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 Instance ID
UniqVpcId Yes String VPC ID
UniqSubnetId Yes String VPC subnet ID
ProxyNodeCustom.N Yes Array of ProxyNodeCustom The specification configuration of a node
SecurityGroup.N No Array of String Security group
Desc No String Description
ConnectionPoolLimit No Integer Connection pool threshold

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Async task ID 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 Creating a database proxy

This example shows you how to create a database proxy for a source instance.

Input Example

POST / HTTP/1.1Host: cdb.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreateCdbProxy<common request parameters>{    "InstanceId": "cdb-aykuksx3",    "UniqVpcId": "vpc-ixw3ll2d",    "UniqSubnetId": "subnet-0z3r56vq",    "Desc": "test",    "ProxyNodeCustom": [        {            "NodeCount": 2,            "Region": "ap-guangzhou",            "Zone": "ap-guangzhou-1",            "Cpu": 1,            "Mem": 1        }    ]}

Output Example

{
    "Response": {
        "RequestId": "123-123",
        "AsyncRequestId": "123-123-123"
    }
}

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.RepeatCreateProxyError The proxy is being created or already exists. You cannot create it again.
InternalError.UnknownError Unknown error
OperationDenied.InstanceStatusError Exceptional instance status
ResourceNotFound.InstanceNotFundError The instance does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

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