1. 接口描述
接口请求域名: dcdb.tencentcloudapi.com 。
本接口(ModifyRealServerAccessStrategy)用于修改云数据库的VPCGW到RS的访问策略。
注意
- 修改策略后只对新建立的连接生效,老连接不受影响
- 就近访问只针对实例是跨可用区部署有用,单可用区部署实例就近与否并无作用
- DB每个Node对应一个proxy,如果开启就近访问,将会把连接集中到对应可用区的proxy上,可能造成热点问题,这种情况下如果是线上业务,请务必根据自己的业务请求量测试符合预期后再进行就近策略变更
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyRealServerAccessStrategy。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-11。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例 ID,格式如:tdsqlshard-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。 |
RsAccessStrategy | 是 | Integer | RS就近模式, 0-无策略, 1-可用区就近访问。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例DEMO
输入示例
https://dcdb.tencentcloudapi.com/?Action=ModifyRealServerAccessStrategy
&InstanceId=tdsqshard-f35wr6wj
&RsAccessStrategy=1
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation.VpcUpdateRouteFailed | VPC更新路由失败。 |
InternalError.GetVpcFailed | 查询虚拟私有网络信息失败。 |
InternalError.OperateDatabaseFailed | 数据库操作失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InstanceNotFound | 未找到请求的实例。 |
InvalidParameter.SubnetUnavailable | snat子网不支持申请IP。 |
InvalidParameter.VpcNotFound | 找不到指定的虚拟私有网络。 |
ResourceUnavailable.InstanceStatusAbnormal | 数据库实例状态不正确,当前无法操作。 |
UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |