Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to create a database proxy for the primary instance.
A maximum of 20 requests can be initiated per second for this API.
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, which can be obtained through the DescribeDBInstances API. |
| UniqVpcId | Yes | String | VPC ID. Obtain through the DescribeDBInstances API. |
| UniqSubnetId | Yes | String | Private subnet ID. Obtain through the DescribeDBInstances API. |
| ProxyNodeCustom.N | Yes | Array of ProxyNodeCustom | Node specification configuration. Parameter description in the example. NodeCount: Number of nodes. Region: Node region. Zone: Node availability zone. Cpu: Number of cores per proxy node (unit: core). Mem: Memory size of each proxy node (unit: MB). Remarks: 1. Database proxy supported node specifications are: 2C4000MB, 4C8000MB, 8C16000MB. 2. The above parameters (such as number of nodes, availability zone) are required. When calling the API, if incomplete, creation may fail. |
| SecurityGroup.N | No | Array of String | Security group |
| Desc | No | String | Description |
| ConnectionPoolLimit | No | Integer | Connection pool threshold Note: If you need to use the database proxy connection pool capability, the kernel minor version of the MySQL 8.0 primary instance must be equal to or greater than MySQL 8.0 20230630. |
| ProxyVersion | No | String | Specify the Linux kernel version of the purchased proxy. Leave it blank to ship the latest version by default. |
| Parameter Name | Type | Description |
|---|---|---|
| AsyncRequestId | String | Asynchronous Task ID |
| 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. |
Create a database proxy for the primary instance
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCdbProxy
<Common request parameters>
{
"InstanceId": "cdb-aykuksx3",
"UniqVpcId": "vpc-ixw3ll2d",
"UniqSubnetId": "subnet-0z3r56vq",
"Desc": "andy_proxy",
"ProxyNodeCustom": [
{
"NodeCount": 2,
"Region": "ap-guangzhou",
"Zone": "ap-guangzhou-1",
"Cpu": 1,
"Mem": 1000
}
]
}
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"AsyncRequestId": "7EF78BEC-0111-43AF-BB11-111112FB54A7"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.InstanceNotFoundError | The instance does not exist. |
피드백