1. 接口描述
接口请求域名: cynosdb.tencentcloudapi.com 。
本接口(CreateProxy)用于开启集群的数据库代理。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateProxy。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-07。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。 |
ClusterId | 是 | String | 集群ID 示例值:cynosdbmysql-mwg7212w |
Cpu | 是 | Integer | cpu核数 示例值:2 |
Mem | 是 | Integer | 内存 示例值:4000 |
UniqueVpcId | 否 | String | 私有网络ID,默认与集群私有网络ID保持一致 |
UniqueSubnetId | 否 | String | 私有网络子网ID,默认与集群子网ID保持一致 |
ProxyCount | 否 | Integer | 数据库代理组节点个数(该参数不再建议使用,建议使用ProxyZones) 示例值:2 |
ConnectionPoolType | 否 | String | 连接池类型:SessionConnectionPool(会话级别连接池 ) 示例值:SessionConnectionPool |
OpenConnectionPool | 否 | String | 是否开启连接池,yes-开启,no-不开启 示例值:yes |
ConnectionPoolTimeOut | 否 | Integer | 连接池阈值:单位(秒) 示例值:0 |
SecurityGroupIds.N | 否 | Array of String | 安全组ID数组 示例值:sg-qwaszx |
Description | 否 | String | 描述说明 |
ProxyZones.N | 否 | Array of ProxyZone | 数据库节点信息(该参数与ProxyCount需要任选一个输入) |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FlowId | Integer | 异步流程ID 示例值:358874 |
TaskId | Integer | 异步任务ID 示例值:1063084 |
ProxyGroupId | String | 数据库代理组ID 示例值:cynosdbmysql-proxy-1qasdfre |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建数据库代理
创建数据库代理
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProxy
<公共请求参数>
{
"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"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.DatabaseAccessError | 数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.FlowCreateError | 创建流程失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.OperationFailedError | 操作失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
InvalidParameter.InvalidParameterError | 未知参数,请检查参数是否有效。 |
OperationDenied.ClusterStatusDeniedError | 集群当前状态不允许该操作。 |
OperationDenied.InstanceStatusDeniedError | 实例当前状态不允许该操作。 |
ResourceNotFound.ClusterNotFoundError | 集群不存在。 |
UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |