CreateProxyEndPoint

마지막 업데이트 시간:2025-11-13 20:51:39

CreateProxyEndPoint

마지막 업데이트 시간: 2025-11-13 20:51:39

1. API Description

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.

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: 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, which is the same as that of the cluster by default.
UniqueSubnetId	Yes	String	VPCe subnet ID, which is the same as that of the cluster by default.
ConnectionPoolType	No	String	Connection pool type. Valid value: `SessionConnectionPool` (session-level connection pool)
OpenConnectionPool	No	String	Whether to enable connection pool. Valid value: `yes` (enable), `no` (disable).
ConnectionPoolTimeOut	No	Integer	Connection pool threshold in seconds
SecurityGroupIds.N	No	Array of String	Array of security group IDs
Description	No	String	Description
Vip	No	String	VIP information
WeightMode	No	String	Weight mode. Valid values: `system` (system-assigned), `custom` (custom).
AutoAddRo	No	String	Whether to automatically add read-only instance. Valid value: `yes`, `no`.
FailOver	No	String	Whether to enable failover
ConsistencyType	No	String	Consistency type. Valid values: `eventual`, `global`, `session`.
RwType	No	String	Read-write attribute. Valid values: `READWRITE`, `READONLY`.
ConsistencyTimeOut	No	Integer	Consistency timeout period
TransSplit	No	Boolean	Transaction split
AccessMode	No	String	Connection mode. Valid values: `nearby`, `balance`.
InstanceWeights.N	No	Array of ProxyInstanceWeight	Instance weight

3. Output Parameters

Parameter Name	Type	Description
FlowId	Integer	Async flow ID
TaskId	Integer	Async 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.

4. Example

Example1 Create a Database Proxy Connection Point

This example shows you how to create a database proxy connection point.

Input Example

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
        }
    ]
}

Output Example

{
    "Response": {
        "FlowId": 146737,
        "TaskId": 187463,
        "ProxyGroupId": "cynosdbmysql-proxy-4378e0kd",
        "RequestId": "a5706353-296a-4992-ad07-ac4a48eeba43"
    }
}

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

Tencent Cloud CLI 3.0

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	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.

문제 해결에 도움이 되었나요?

더 자세한 내용은 문의하기 또는 티켓 제출 을 통해 문의할 수 있습니다.

예

아니오

피드백

tencent cloud