Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to create a database proxy connection point.
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: CreateProxyEndPoint. |
| 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. |
| UniqueVpcId | Yes | String | VPC ID. |
| UniqueSubnetId | Yes | String | VPC subnet ID. |
| ConnectionPoolType | No | String | Connection pool Type: SessionConnectionPool (session-level connection pool). |
| OpenConnectionPool | No | String | Whether the connection pool is enabled. |
| ConnectionPoolTimeOut | No | Integer | Connection pool threshold: measurement unit (seconds), optional range: 0 - 300 seconds. |
| SecurityGroupIds.N | No | Array of String | Bound security group ID array. |
| Description | No | String | Description. |
| Vip | No | String | vip information that should be bound must correspond to UniqueVpcId. |
| WeightMode | No | String | Weight mode: |
| AutoAddRo | No | String | Automatically add read-only instance. |
| FailOver | No | String | Whether fault migration is enabled. |
| ConsistencyType | No | String | Consistency type: |
| RwType | No | String | Read-write attribute: |
| ConsistencyTimeOut | No | Integer | Consistency timeout. Value ranges from 0 to 1000000 (microseconds). When set to 0, it means the request will wait if the read-only instance fails to satisfy the consistency policy due to latency. |
| TransSplit | No | Boolean | Whether to enable transaction split. Once enabled, read and write operations in a transaction are split and executed on different instances. |
| AccessMode | No | String | Access mode: |
| InstanceWeights.N | No | Array of ProxyInstanceWeight | Instance weight. |
| LoadBalanceMode | No | String |
| 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. |
This example shows you how to create a database proxy connection point.
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProxyEndPoint
<Common request parameters>
{
"ClusterId": "cynosdbmysql-dnofdr2d",
"UniqueVpcId": "vpc-azx",
"UniqueSubnetId": "subnet-qwe",
"ConnectionPoolType": "SessionConnectionPool",
"OpenConnectionPool": "yes",
"ConnectionPoolTimeOut": 0,
"SecurityGroupIds": [
"sg-dtwhs6"
],
"Description": "tomnode1",
"Vip": "1.1.1.1",
"WeightMode": "system",
"AutoAddRo": "yes",
"FailOver": "",
"ConsistencyType": "eventual",
"RwType": "READWRITE",
"ConsistencyTimeOut": 0,
"TransSplit": true,
"AccessMode": "nearby",
"InstanceWeights": [
{
"InstanceId": "cynosdbmysql-ins-c2twj0qf",
"Weight": 0
}
]
}
{
"Response": {
"FlowId": 146737,
"TaskId": 187463,
"ProxyGroupId": "cynosdbmysql-proxy-4378e0kd",
"RequestId": "a5706353-296a-4992-ad07-ac4a48eeba43"
}
}
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 | 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.OperationFailedError | Operation failed. Try again later. If the problem persists, contact customer service. |
| InvalidParameter.InvalidParameterError | Unknown parameter. Please check whether the parameter is valid. |
| InvalidParameterValue.InvalidZoneIdError | Invalid AZ |
| OperationDenied.ClusterOpNotAllowedError | The current cluster does not allow the operation. |
| OperationDenied.InstanceStatusDeniedError | For the instance in this status, the operation is not allowed. |
| ResourceNotFound.ClusterNotFoundError | The cluster does not exist. |
| ResourceNotFound.InstanceNotFoundError | The instance does not exist. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
フィードバック