1. 接口描述
接口请求域名： cdb.tencentcloudapi.com 。
本接口（ModifyRoGroupInfo）用于更新云数据库只读组的信息。包括设置实例延迟超限剔除策略，设置只读实例读权重，设置复制延迟时间等。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyRoGroupInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| RoGroupId | 是 | String | RO 组的 ID。 示例值：cdbrg-iup41a4t |
| RoGroupInfo | 否 | RoGroupAttr | RO 组的详细信息。 |
| RoWeightValues.N | 否 | Array of RoWeightValue | RO 组内实例的权重。若修改 RO 组的权重模式为用户自定义模式（custom），则必须设置该参数，且需要设置每个 RO 实例的权重值。 |
| IsBalanceRoLoad | 否 | Integer | 是否重新均衡 RO 组内的 RO 实例的负载。支持值包括：1 - 重新均衡负载；0 - 不重新均衡负载。默认值为 0。注意，设置为重新均衡负载时，RO 组内 RO 实例会有一次数据库连接瞬断，请确保应用程序能重连数据库。 示例值：1 |
| ReplicationDelayTime | 否 | Integer | 废弃参数，无意义。 示例值：1000 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AsyncRequestId | String | 异步任务 ID。 注意：此字段可能返回 null，表示取不到有效值。 示例值：dadaddasda-23adcasdasd-asdaasc |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 设置RO组的延迟剔除策略
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRoGroupInfo
<公共请求参数>
{
"RoGroupId": "cdbrg-iup41a4t",
"RoGroupInfo": {
"RoOfflineDelay": "1",
"MinRoInGroup": "1",
"RoMaxDelayTime": "10"
}
}输出示例
{
"Response": {
"RequestId": "xx",
"AsyncRequestId": "xx"
}
}示例2 重新均衡RO组内实例的权重
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRoGroupInfo
<公共请求参数>
{
"RoWeightValues": [
{
"InstanceId": "cdbr0-test1234",
"Weight": "70"
},
{
"InstanceId": "cdbr0-iup41a4t",
"Weight": "30"
}
],
"IsBalanceRoLoad": "1",
"RoGroupId": "cdbrg-iup41a4t",
"RoGroupInfo": {
"WeightMode": "custom"
}
}输出示例
{
"Response": {
"RequestId": "xx",
"AsyncRequestId": "xx"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DescribeProxyGroupError | 查询数据库代理失败。 |
| FailedOperation.StatusConflict | 任务状态冲突。 |
| InternalError.DBRecordNotExistError | 数据库实例不存在。 |
| InternalError.DatabaseAccessError | 数据库内部错误。 |
| InternalError.TaskFrameError | 异步任务错误。 |
| InternalError.UnknownError | 未知错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InstanceNotFound | 实例不存在。 |
| InvalidParameterValue.DataConvertError | 数据转换失败。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
| MissingParameter.MissingParamError | 缺少必要参数。 |
| OperationDenied.ConflictRoStatus | 当前RO组有RO实例处于非法状态，不允许执行当前操作。 |
| OperationDenied.ConflictStatus | 当前只读组配置正在变更中，请勿重复发起请求。 |
| OperationDenied.DelayReplicationRunning | 延迟复制正在运行，不允许执行操作。 |
| OperationDenied.InstanceLockerConflict | 实例锁冲突，请稍后重试。 |
| ResourceNotFound.CdbInstanceNotFoundError | 未找到数据库实例，请确认您的实例状态是否正常。 |
