该接口用于申请只读地址。
接口说明
适用引擎
- RDS MySQL
- RDS SQL Server
功能描述
对拥有只读实例的SQL Server主实例,可以创建统一只读地址。创建该地址后,不影响原主实例、只读实例的已有访问地址,以及正常的内外网申请。
前体条件
调用该接口时,实例必须满足以下条件,否则将操作失败:
- MySQL实例使用的是共享代理。
- 实例状态为运行中。
- 实例拥有只读实例。
- 实例没有正在执行的DTS迁移任务。
- 实例为如下版本:
- SQL Server集群版。
- MySQL 5.7高可用版(本地SSD盘)
- MySQL 5.6
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:AllocateReadWriteSplittingConnection | WRITE |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 |
主实例ID。可调用DescribeDBInstances获取。 |
rm-uf6wjk5**** |
ConnectionStringPrefix | string | 否 |
只读地址前缀名,不可重复,由小写字母和中划线组成,需以字母开头,长度不超过30个字符。 说明 | rr-m5e****-rw.mysql.rds.aliyuncs.com |
Port | string | 否 | 只读地址端口,取值为1000~5999,默认为1433。 |
1433 |
MaxDelayTime | string | 否 |
延迟阈值,范围是0~7200,单位:秒,默认为30。 说明 | 30 |
NetType | string | 否 | 只读地址的网络类型,取值:
说明 | Intranet |
DistributionType | string | 否 | 读权重分配模式,取值:
|
Standard |
Weight | string | 否 |
读权重分配,即传入主实例和只读实例的读请求比例。以100进行递增,最大值为10000。
说明 |
{ “rm-bp1****”: 800, “master”: 400, “slave”: 400 } |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object |
返回参数详情。 |
||
RequestId | string |
请求ID。 |
4C467B38-3910-447D-87BC-AC049166F216 |
示例
正常返回示例
JSON
格式
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2022-06-23 | OpenAPI 描述信息更新 | 看变更集 | ||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/154125.html