Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to enable the database proxy for a cluster.
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: CreateProxy. |
| 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. |
| ClusterId | Yes | String | Cluster ID |
| Cpu | Yes | Integer | Number of CPU cores |
| Mem | Yes | Integer | memory |
| UniqueVpcId | No | String | VPC ID. Default value: the VPC ID of the cluster. |
| UniqueSubnetId | No | String | VPC subnet ID. Default value: the cluster subnet ID. |
| ProxyCount | No | Integer | Number of database proxy group nodes (this parameter is no longer recommended. Use ProxyZones instead) |
| ConnectionPoolType | No | String | Connection pool type: SessionConnectionPool (session-level connection pool) |
| OpenConnectionPool | No | String | Whether connection pool is enabled. yes: enabled; no: not enabled |
| ConnectionPoolTimeOut | No | Integer | Connection pool threshold. Unit: second |
| SecurityGroupIds.N | No | Array of String | Security group ID array |
| Description | No | String | Description. |
| ProxyZones.N | No | Array of ProxyZone | Database node information (either this parameter or ProxyCount is required) |
| Parameter Name | Type | Description |
|---|---|---|
| FlowId | Integer | Async process ID |
| TaskId | Integer | Asynchronous Task ID |
| ProxyGroupId | String | Database Proxy Group 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
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProxy
<Common request parameters>
{
"ClusterId": "cynosdbmysql-mwg7212w",
"UniqueVpcId": "vpc-4pbgo2lk",
"UniqueSubnetId": "subnet-a2emqn1t",
"ProxyCount": 2,
"Cpu": 2,
"Mem": 4000,
"ConnectionPoolType": "SessionConnectionPool",
"OpenConnectionPool": "yes",
"ConnectionPoolTimeOut": 0,
"SecurityGroupIds": [
"sg-qwaszx"
],
"Description": "Fill in the description",
"ProxyZones": [
{
"ProxyNodeZone": "ap-beijing-6",
"ProxyNodeCount": 2
}
]
}{
"Response": {
"FlowId": 358874,
"TaskId": 1063084,
"RequestId": "a88257ed-174e-499c-b390-dc535e664b94"
}
}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 | Operation failed. |
| FailedOperation.DatabaseAccessError | Database access failed. Try again later. If the issue persists, contact customer service. |
| FailedOperation.FlowCreateError | Failed to create the process. Please retry later. If the issue continues, contact customer service. |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the issue persists, contact customer service. |
| InvalidParameter.InvalidParameterError | Unknown parameter. Check whether the parameter is valid. |
| OperationDenied.ClusterStatusDeniedError | Operation not allowed in the current status of the cluster. |
| OperationDenied.InstanceStatusDeniedError | Operation not allowed in the current instance status. |
| ResourceNotFound.ClusterNotFoundError | The cluster does not exist. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
文档反馈