文档

AllocateReadWriteSplittingConnection - 申请只读地址

更新时间:

该接口用于申请只读地址。

接口说明

适用引擎

  • 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:AllocateReadWriteSplittingConnectionWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

主实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
ConnectionStringPrefixstring

只读地址前缀名,不可重复,由小写字母和中划线组成,需以字母开头,长度不超过 30 个字符。

说明 默认以“实例名+rw”字符串组成前缀。
rr-m5e****-rw.mysql.rds.aliyuncs.com
Portstring

只读地址端口,取值为 1000~5999,默认为 1433。

1433
MaxDelayTimestring

延迟阈值,范围是 0~7200,单位:秒,默认为 30。

说明 当只读实例延迟超过该阈值时,读取流量不发往该实例。
30
NetTypestring

只读地址的网络类型,取值:

  • Internet:外网
  • Intranet:内网
说明 默认为内网,且内网类型与主实例保持一致。
Intranet
DistributionTypestring

读权重分配模式,取值:

  • Standard:按规格权重自动分配
  • Custom:自定义分配权重
Standard
Weightstring

读权重分配,即传入主实例和只读实例的读请求比例。以 100 进行递增,最大值为 10000。

  • RDS 实例格式:{"<只读实例 ID>":<权重>,"master":<权重>,"slave":<权重>}
  • MyBASE 实例格式:[{"instanceName":"<主实例 ID>","weight":<权重>,"role":"master"},{"instanceName":"<主实例 ID>","weight":<权重>,"role":"slave"},{"instanceName":"<只读实例 ID>","weight":<权重>,"role":"master"}]
说明
  • DistributionTypeCustom 时,必须传入该参数。
  • DisrtibutionTypeStandard 时,传入该参数无效。
  • { "rm-bp1****": 800, "master": 400, "slave": 400 }

    返回参数

    名称类型描述示例值
    object

    返回参数详情。

    RequestIdstring

    请求 ID。

    4C467B38-3910-447D-87BC-AC049166F216

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    }

    错误码

    HTTP status code错误码错误信息描述
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
    400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
    400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
    400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2022-06-23OpenAPI 描述信息更新看变更集
    变更项变更内容
    API 描述OpenAPI 描述信息更新
    • 本页导读 (1)
    文档反馈