操作指南

API 文档

配置数据库代理读写分离

最近更新时间:2022-04-19 06:06:12

我的收藏

1. 接口描述

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

配置数据库代理读写分离

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyCDBProxy。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
ProxyGroupId String 数据库代理组唯一ID
IsKickout Boolean 是否开始延迟剔除,默认false,取值:"true" | "false"
MinCount Integer 最少保留数,最小为0,最大为实例数量
MaxDelay Integer 延迟剔除的阈值;如果IsKickOut="true", 该字段必填
WeightMode String 读写权重分配模式;系统自动分配:"system", 自定义:"custom"
RoWeightValues RoWeight 实例只读权重
FailOver Boolean 是否开启故障转移,代理出现故障后,连接地址将路由到主实例,默认false,取值:"true" | "false"
AutoAddRo Boolean 是否自动添加只读实例,默认false,取值:"true" | "false"

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 配置数据库读写分离

输入示例

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

{
    "RoWeightValues": {},
    "MaxDelay": 1,
    "AutoAddRo": true,
    "ProxyGroupId": "proxy-test",
    "IsKickout": true,
    "FailOver": true,
    "MinCount": 1,
    "WeightMode": "system"
}

输出示例

{
  "Response": {
    "RequestId": "122198-2222-1223-2222-c3a1733"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ProxyGroupStatusError 数据库代理状态异常。
InvalidParameterValue.InvalidParameterValueError 参数值无效。
目录