1. 接口描述
接口请求域名： cdb.tencentcloudapi.com 。
针对主实例申请创建数据库代理。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ApplyCDBProxy。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 主实例唯一标识ID |
| UniqVpcId | 是 | String | 私有网络ID |
| UniqSubnetId | 是 | String | 私有网络子网ID |
| ProxyCount | 是 | Integer | 代理组节点个数 |
| Cpu | 是 | Integer | cpu核数 |
| Mem | 是 | Integer | 内存 |
| SecurityGroup.N | 否 | Array of String | 安全组 |
| Desc | 否 | String | 描述说明，最大支持256位。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AsyncRequestId | String | 异步处理ID 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建数据库代理
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplyCDBProxy
<公共请求参数>
{
"UniqVpcId": "xx",
"InstanceId": "xx",
"SecurityGroup": [
"xx"
],
"Mem": 1,
"UniqSubnetId": "xx",
"Desc": "xx",
"Cpu": 1,
"ProxyCount": 1
}输出示例
{
"Response": {
"AsyncRequestId": "dd803e8b-02543d6b-0b6ec9c4-8c1e133c",
"RequestId": "6236a2ad-0557-48c3-b983-247d2870e0a1"
}
}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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.RepeatCreateProxyError | 代理创建中或则已存在，请勿重复创建。 |