创建数据库代理

最近更新时间:2024-05-14 01:21:43

我的收藏

1. 接口描述

接口请求域名: cdb.tencentcloudapi.com 。

主实例创建数据库代理

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCdbProxy。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
示例值:cdb-aykuksx3
UniqVpcId String 私有网络ID
示例值:vpc-ixw3ll2d
UniqSubnetId String 私有子网ID
示例值:subnet-0z3r56vq
ProxyNodeCustom.N Array of ProxyNodeCustom 节点规格配置
备注:数据库代理支持的节点规格为:2C4000MB、4C8000MB、8C16000MB。
示例中参数说明:
NodeCount:节点个数。
Region:节点地域。
Zone:节点可用区。
Cpu:单个代理节点核数(单位:核)。
Mem:单个代理节点内存数(单位:MB)。
示例值:{ "NodeCount": 2, "Region": "ap-guangzhou", "Zone": "ap-guangzhou-1", "Cpu": 2, "Mem": 4000 }
SecurityGroup.N Array of String 安全组
示例值:[{"security"}]
Desc String 描述
示例值:test
ConnectionPoolLimit Integer 连接池阈值
注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
示例值:10
ProxyVersion String 指定要购买的 proxy 内核版本。不填则默认发货最新版本的 proxy。
示例值:1.4.1

3. 输出参数

参数名称 类型 描述
AsyncRequestId String 异步任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:adasc-asdas-123
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建数据库代理

主实例创建数据库代理

输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCdbProxy
<公共请求参数>

{
    "InstanceId": "cdb-aykuksx3",
    "UniqVpcId": "vpc-ixw3ll2d",
    "UniqSubnetId": "subnet-0z3r56vq",
    "Desc": "test",
    "ProxyNodeCustom": [
        {
            "NodeCount": 2,
            "Region": "ap-guangzhou",
            "Zone": "ap-guangzhou-1",
            "Cpu": 1,
            "Mem": 1
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "123-123",
        "AsyncRequestId": "123-123-123"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.RepeatCreateProxyError 代理创建中或则已存在,请勿重复创建。
InternalError.UnknownError 未知错误。
OperationDenied.InstanceStatusError 实例状态异常。
ResourceNotFound.InstanceNotFundError 该实例不存在。