文档

ModifyDBEndpointAddress - 修改集群连接地址

更新时间:

修改PolarDB集群的连接地址,包括主地址、默认集群地址、自定义集群地址和私有域名。

调试

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

调试

授权信息

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

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

请求参数

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

集群 ID。

说明 您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息,包括集群 ID。
pc-***************
DBEndpointIdstring

连接地址 ID。

说明 您可以通过接口 DescribeDBClusterEndpoints 查询连接地址 ID。
pe-****************
NetTypestring

连接地址的网络类型,取值范围如下:

  • Public:公网
  • Private:私网
  • Inner:经典网络

仅 PolarDB MySQL 版集群支持经典网络类型。

Public
ConnectionStringPrefixstring

新的连接地址前缀,需满足如下条件:

  • 由小写字母、数字、中划线(-)组成。
  • 以字母开头,以数字或字母结尾。
  • 长度为 6~30 个字符。
example
PrivateZoneAddressPrefixstring

私有域名前缀。需满足如下条件:

  • 由小写字母、数字、中划线(-)组成。
  • 以字母开头,以数字或字母结尾。
  • 长度为 6~30 个字符。
说明
  • 对于 PolarDB 的每一个私网地址,均可以绑定一个用户的私有域名,该域名仅在当前地域内指定的 VPC 中生效。私有域名实际上是通过 PrivateZone 管理的,通过 CNAME 映射到 PolarDB 自带的私网地址上,该功能 PrivateZone 会收取少量费用,请参见产品定价
  • NetType=Private时该参数有意义。
  • aliyundoc
    PrivateZoneNamestring

    私有域名 Zone 名称。

    说明 NetType=Private时该参数有意义。
    aliyundoc.com
    Portstring

    端口号,取值范围为 3000~5999。

    说明
  • 仅 PolarDB MySQL 版集群支持该参数,若该参数留空,则默认端口号为 3306。
  • 3306

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    D0CEC6AC-7760-409A-A0D5-E6CD86******

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
    }

    错误码

    HTTP status code错误码错误信息描述
    400DnsConflictParamsError.DnsConflict(Dns is already used, ConnAddrCust:%s).参数错误DNS冲突(DNS已经使用,连接地址:%s)。
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。

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

    变更历史

    变更时间变更内容概要操作
    2023-12-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:404
      新增错误码:400
    • 本页导读 (0)
    文档反馈