详情页标题前

阿里云RDS数据库ModifyDBProxyEndpoint – 修改数据库独享代理的代理终端-云淘科技

• 阿里云数据库
详情页1

该接口用于修改RDS实例数据库独享代理的代理终端配置。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL

相关功能文档

注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。

  • RDS MySQL开通并配置数据库代理服务
  • RDS PostgreSQL新增数据库代理终端

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。

调试阿里云RDS数据库ModifyDBProxyEndpoint - 修改数据库独享代理的代理终端-云淘科技调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作 访问级别 资源类型 条件关键字 关联操作
rds:ModifyDBProxyEndpoint WRITE
  • DBInstanceacs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
 无

请求参数

名称 类型 必填 描述 示例值
DBInstanceId string 是

实例ID。可调用DescribeDBInstances获取。

 rm-bp145737x5bi6****
DBProxyEndpointId string 是

代理连接地址ID。可以通过接口DescribeDBProxyEndpoint查看。

说明

  • MySQL：当DbEndpointOperator取值为Delete或Modify时，本参数必须传入。
  • PostgreSQL：当DbEndpointOperator取值为Delete、Modify或Create时，本参数必须传入。
    		•  gos787jog2wk0y****
    ConfigDBProxyFeatures string 否

    设置代理连接地址想要开通的独享代理功能，各功能之间以英文分号（;）隔开。格式：功能1:开通情况;功能2:开通情况;... ，末尾不加英文分号（;）。

    功能取值：

    • ReadWriteSpliting：读写分离
    • ConnectionPersist：连接池
    • TransactionReadSqlRouteOptimizeStatus：事务拆分

    开通情况取值：

    • 1：功能已开通
    • 0：功能未开通

    说明
    RDS PostgreSQL仅支持设置ReadWriteSpliting。

    		ReadWriteSpliting:1;ConnectionPersist:0
    RegionIdstring否

    地域ID。可调用DescribeRegions获取。

    		 cn-hangzhou
    ReadOnlyInstanceMaxDelayTime string 否

    读写分离中只读实例的最大延迟阈值，当只读实例延迟时间超过该值时，读取流量不发往该实例，单位：秒。不传该参数则保持原值。取值：0~3600。默认值：30。

    说明
    开通读写分离时才需要传入该参数。

    		30
    ReadOnlyInstanceDistributionTypestring否

    读权重分配模式。取值：

    • Standard：按规格权重自动分配。
    • Custom：自定义分配权重。

    说明
    开通读写分离时才需要传入该参数。权限分配模式的详细信息，MySQL请参见读权重分配，PostgreSQL请参见开通并配置数据库代理服务。

    		Standard
    ReadOnlyInstanceWeightstring否

    自定义读权重分配，即传入主实例和只读实例的读请求权重。以100递增，最大值为10000，格式：

    • 常规实例：{"主实例ID":"权重","只读实例ID":"权重"...}

      示例：{"rm-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...}

    • RDS MySQL集群版实例：{"只读实例ID":"权重","DBClusterNode":{"主节点ID":"权重","备节点ID":"权重","备节点ID":"权重"...}}

      示例：{"rr-tfhfgk5****":"200","DBClusterNode":{"rn-2z****":"0","rn-2z****":"400","rn-2z****":"400"...}}

      说明
      DBClusterNode为集群版独有的请求信息，包含主备节点的NodeID以及权重。

    		 {“rm-uf6wjk5****”:”500″,”rr-tfhfgk5xxx”:”200″…}
    DbEndpointOperator string 否

    操作类型，取值：

    • Modify：默认值，修改代理终端。
    • Create：新建代理终端。
    • Delete：删除代理终端。
    		 Modify
    DbEndpointAliases string 否

    代理终端的备注信息。

    		 test-proxy
    DbEndpointType string 否

    代理终端的类型，保留参数，无需设置。

    		 RWSplit
    DbEndpointReadWriteMode string 否

    读写类型，取值：

    • ReadWrite：连接主实例，可接受写请求。
    • ReadOnly：默认值，不连接主实例，无法接受写请求。

    说明

  • 当DbEndpointOperator取值为Create时，本参数必须传入。
  • RDS MySQL实例中，本参数的取值从ReadWrite更换为ReadOnly时，会关闭事务拆分功能。
    		•  ReadWrite
    DBProxyEngineType string 否

    预留参数，无需配置。

    		 normal

    返回参数

    名称 类型 描述 示例值
    object

    返回参数详情。
    RequestId string

    请求ID。

    		 6B50D92C-1960-4D4F-A290-AFADD6B1A5C8

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "6B50D92C-1960-4D4F-A290-AFADD6B1A5C8"
}

    错误码

    HTTP status code 错误码 错误信息 描述
    400 InvalidVpcInstanceId The specified VPC instance ID is invalid. 操作失败，当前VPC instance ID无效。
    400 InvalidEndPoint.Format The specified EndPoint is not valid. 独享代理连接地址ID（DBProxyEndpointId）未传，查询不存在， 请检查Endpoint参数。
    400 InvalidEndpointType.Format The specified EndpointType is invalid. 指定的EndpointType无效，请检查参数正确性。
    400 IncorrectDBInstanceNetType The current database instance network type does not support the operation. 操作失败，数据库实例网络类型不支持此操作。
    400 EndpointNum.Error The number of endpoint is invalid. 当前终端数量不符合要求，请检查支持的终端数量。
    400 EndpointTypeOperation.NotSupport The endpoint type does not support the operation. 当前终端类型不支持此操作，请检查代理终端类型。
    400 InvalidDBInstanceName Specified parameter DBInstanceName is not valid. 指定的实例名称（DBInstanceName）无效，请检查参数值是否为null或空字符串。
    400 ClusterEndpoint.StatusNotValid The cluster endpoint status is invalid. 集群endpoint 状态无效。
    403 MaxScaleLevel.NotSupport The current maxscale ins_num does not support this operation. 操作失败，当前数据库代理规格不支持此操作。
    403 ReadDBInstance.NotFound The current database instance does not contain any read only instance. 当前数据库实例没有只读实例。
    403 IncorrectKindCode The current KindCode of the custins does not support the operation. 操作失败，当前实例所属环境类型不支持，请检查接口支持的实例类型。
    403 IncorrectDBInstanceState The current database instance state does not support the operation. 操作失败，数据库状态不支持此操作。请查看数据库信息，确保数据库状态为运行中。
    404 EndpointConfig.Invalid Please check the endpoint config parameter. 代理终端配置不正确。请检查参数是否正确。
    404 Readins.NotFound The current instance does not contain any read only instance. The operation is not supported. 操作失败，当前实例不存在只读实例。
    404 Endpoint.NotFound Specified endpoint is not found. 未找到指定独享代理连接地址的端口。
    404 EndpointType.NotFound The specified endpoint type is not found. 操作失败，未知的代理终端类型，请检查终端类型。
    404 InvalidReadDBInstance.NotFound The specified read only database instance does not exist. 只读实例未创建或请求实例参数有误。
    404 InvalidParam The specified Weight is invalid. 权重无效。

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

    变更历史

    变更时间 变更内容概要 操作
    2022-06-23 OpenAPI 描述信息更新，OpenAPI 错误码发生变更 看变更集
    变更项 变更内容
    API 描述 OpenAPI 描述信息更新
    错误码 OpenAPI 错误码发生变更
      删除错误码：400
      删除错误码：403
      删除错误码：404
    2022-06-08 OpenAPI 错误码发生变更，OpenAPI 入参发生变更 看变更集
    变更项 变更内容
    错误码 OpenAPI 错误码发生变更
      删除错误码：400
      删除错误码：403
      删除错误码：404
    入参 OpenAPI 入参发生变更
      新增入参：DBProxyEngineType

    内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家

    阿里云企业补贴进行中： 马上申请

    腾讯云限时活动1折起，即将结束： 马上收藏

    同尘科技为腾讯云授权服务中心。

    购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠

    转转请注明出处：https://www.yunxiaoer.com/156496.html

    赞 (0)
    0
    上一篇 2023年12月9日
    下一篇 2023年12月9日
    详情页2

    相关推荐

    联系我们

    400-800-8888

    在线咨询： QQ交谈

    邮件：admin@example.com

    工作时间：周一至周五，9:30-18:30，节假日休息

    关注微信
    本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买，续费优惠，保证底价，买贵退差。