tencent cloud

APIs

CreateProxyEndPoint

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-10-28 10:18:51

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.

UniqueSubnetId Yes String

VPC subnet ID.

ConnectionPoolType No String

Connection pool type: SessionConnectionPool (session-level connection pool).

OpenConnectionPool No String

Whether to enable the connection pool.
yes: enable.
no: disabled.

ConnectionPoolTimeOut No Integer

Connection pool threshold: 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, which must correspond to UniqueVpcId.

WeightMode No String

Weight mode:
system: system-assigned.
custom: custom.

AutoAddRo No String

Whether to automatically add a read-only instance.
yes: automatically add a read-only instance.
no: do not automatically add a read-only instance.

FailOver No String

Whether to enable fault migration.
yes: enabled. Once enabled, when a database proxy failure occurs, the connection address will be routed to the primary instance.
no: disabled.
Description:
This item can be set only when the RwType parameter value is READWRITE.

ConsistencyType No String

Consistency type:
eventual: final consistency.
global: global consistency.
session: session consistency.
Description:
This item can be set only when the RwType parameter value is READWRITE.

RwType No String

Read-write attribute:
READWRITE: read-write separation. Only when this parameter is set to READWRITE can you set the FailOver and ConsistencyType parameters.
READONLY: read-only.

ConsistencyTimeOut No Integer

Consistency timeout. Value range: 0–1000000 (µs). When set to 0, if a read-only instance has latency causing the consistency policy to fail, the request will wait indefinitely.

TransSplit No Boolean

Whether to enable transaction splitting. Once enabled, reads and writes are split within a transaction and executed on different instances.

AccessMode No String

Access mode:
nearby: nearest access.
balance: balanced distribution.

InstanceWeights.N No Array of ProxyInstanceWeight

Instance weight.

LoadBalanceMode No String

Load balancing mode

Enumeration values:

  • static: Static load
  • dynamic: Dynamic load
TransAllSplit No Boolean

Whether to enable full transactional sharding. In a transaction, split the reads before and after the transactional write to different instances for execution.

3. Output Parameters

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.

4. Example

Example1 Creating a Database Proxy Connection Point

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

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 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.
InvalidParameterValue.InvalidZoneIdError Invalid AZ.
OperationDenied.ClusterOpNotAllowedError Operation forbidden. The current cluster does not allow this operation.
OperationDenied.InstanceStatusDeniedError Operation not allowed in the current instance status.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication failed.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan