云数据库 MySQL
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云数据库 MySQL > API 文档 > 数据库代理相关接口 > 调整数据库代理地址

调整数据库代理地址

最近更新时间：2024-03-12 01:13:28

我的收藏

本页目录：

1. 接口描述

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

调整数据库代理地址配置

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：AdjustCdbProxyAddress。
Version 是 String 公共参数，本接口取值：2017-03-20。
Region 是 String 公共参数，详见产品支持的 地域列表。
ProxyGroupId 是 String 代理组ID
示例值：proxy-test
WeightMode 是 String 权重分配模式，
系统自动分配："system"， 自定义："custom"
示例值：system
IsKickOut 是 Boolean 是否开启延迟剔除，取值："true" | "false"
示例值：true
MinCount 是 Integer 最小保留数量，最小取值：0
示例值：2
MaxDelay 是 Integer 延迟剔除阈值，最小取值：0
示例值：100
FailOver 是 Boolean 是否开启故障转移，取值："true" | "false"
示例值：true
AutoAddRo 是 Boolean 是否自动添加RO，取值："true" | "false"
示例值：true
ReadOnly 是 Boolean 是否是只读，取值："true" | "false"
示例值：true
ProxyAddressId 是 String 代理组地址ID
示例值：proxy-test
TransSplit 否 Boolean 是否开启事务分离，取值："true" | "false"
示例值：true
ConnectionPool 否 Boolean 是否开启连接池
示例值：true
ProxyAllocation.N 否 Array of ProxyAllocation 读写权重分配。如果 WeightMode 传的是 system ，则传入的权重不生效，由系统分配默认权重。

3. 输出参数

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

4. 示例

示例1 调整数据库代理地址

调整数据库代理地址

输入示例

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

{
    "ProxyGroupId": "proxy-il2nlsdn",
    "ProxyAddressId": "proxy-il2nlsdn",
    "IsKickOut": true,
    "MinCount": 1,
    "MaxDelay": 10,
    "WeightMode": "custom",
    "FailOver": true,
    "AutoAddRo": true,
    "ReadOnly": false,
    "TransSplit": false,
    "ConnectionPool": true,
    "ProxyAllocation": [
        {
            "Region": "ap-guangzhou",
            "Zone": "ap-guangzhou-2",
            "ProxyInstance": [
                {
                    "InstanceId": "cdb-aykuksx3",
                    "Weight": 100
                }
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "111-1314-333-2321212",
        "AsyncRequestId": "test"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DescribeProxyGroupError 查询数据库代理失败。
FailedOperation.FailedOperationError 不支持当前操作。
InternalError.UnknownError 未知错误。
InvalidParameter.InvalidParameterError 无效的参数值。
InvalidParameterValue.InvalidParameterValueError 参数值无效。
OperationDenied.ProxyUpgradeTaskStatusError 数据库代理升级任务中，不允许该操作。
OperationDenied.UnsupportCreateAddressError 不支持创建代理地址。
ResourceNotFound.InstanceNotFundError 该实例不存在。
中国站