配置数据库代理读写分离

最近更新时间:2024-10-31 01:28:08

我的收藏

1. 接口描述

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

本接口(ModifyProxyRwSplit)用于配置数据库代理读写分离。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyProxyRwSplit。
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-asd123
示例值:cynosdbmysql-xxxxxxx
ProxyGroupId String 数据库代理组ID,例如cynosdbmysql-proxy-qwe123
ConsistencyType String 一致性类型;“eventual"-最终一致性, "session"-会话一致性, "global"-全局一致性
ConsistencyTimeOut String 一致性超时时间。
取值范围:0~1000000(微秒),设置0则表示若只读实例出现延迟, 导致一致性策略不满足, 请求将一直等待。
WeightMode String 读写权重分配模式;系统自动分配:"system", 自定义:"custom"
InstanceWeights.N Array of ProxyInstanceWeight 实例只读权重。
该参数必填。
FailOver String 是否开启故障转移,代理出现故障后,连接地址将路由到主实例,取值:"yes" , "no"
AutoAddRo String 是否自动添加只读实例,取值:"yes" , "no"
OpenRw String 是否打开读写分离。
该参数已废弃,请通过RwType设置读写属性。
RwType String 读写类型:
READWRITE,READONLY
TransSplit Boolean 事务拆分。
在一个事务中拆分读和写到不同的实例上去执行。
AccessMode String 连接模式:
nearby,balance
OpenConnectionPool String 是否打开连接池:
yes,no
ConnectionPoolType String 连接池类型:
SessionConnectionPool
ConnectionPoolTimeOut Integer 连接池时间。
可选范围:0~300(秒)

3. 输出参数

参数名称 类型 描述
FlowId Integer 异步FlowId
TaskId Integer 异步任务ID
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

配置数据库代理读写分离

输入示例

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

{
    "ClusterId": "cynosdbmysql-dnofdr2d",
    "ProxyGroupId": "cynosdbmysql-proxy-4378e0kd",
    "ConsistencyType": "eventual",
    "ConsistencyTimeOut": "10",
    "WeightMode": "system",
    "InstanceWeights": [
        {
            "InstanceId": "cynosdbmysql-ins-c2twj0qf",
            "Weight": 0
        }
    ],
    "FailOver": "",
    "AutoAddRo": "yes",
    "OpenRw": "yes",
    "RwType": "READONLY",
    "TransSplit": true,
    "AccessMode": "nearby",
    "OpenConnectionPool": "yes",
    "ConnectionPoolType": "SessionConnectionPool",
    "ConnectionPoolTimeOut": 0
}

输出示例

{
    "Response": {
        "FlowId": 134762,
        "TaskId": 146783,
        "RequestId": "a5706353-296a-4992-ad07-ac4a48eeba43"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.DatabaseAccessError 数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.FlowCreateError 创建流程失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.OperationFailedError 操作失败,请稍后重试。如果持续不成功,请联系客服进行处理。
InvalidParameter.InvalidParameterError 未知参数,请检查参数是否有效。
InvalidParameterValue.InvalidParameterValueError 参数值无效。
OperationDenied.ClusterStatusDeniedError 集群当前状态不允许该操作。
OperationDenied.InstanceStatusDeniedError 实例当前状态不允许该操作。
ResourceNotFound.InstanceNotFoundError 实例不存在。
UnauthorizedOperation.PermissionDenied CAM鉴权不通过。