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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ModifyDBEndpointAddress

系统规定参数，取值为ModifyDBEndpointAddress。

DBClusterId String 是 pc-***************

集群ID。

说明 您可以通过DescribeDBClusters接口查看账号下所有集群的详细信息，包括集群ID。
DBEndpointId String 是 pe-****************

连接地址ID。

说明 您可以通过接口DescribeDBClusterEndpoints查询连接地址ID。
NetType String 是 Public

连接地址的网络类型，取值范围如下：

  • Public：公网

  • Private：私网

ConnectionStringPrefix String 否 example

新的连接地址前缀，需满足如下条件：

  • 由小写字母、数字、中划线（-）组成。
  • 以字母开头，以数字或字母结尾。
  • 长度为6~30个字符。
PrivateZoneAddressPrefix String 否 aliyundoc

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

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

私有域名Zone名称。

说明 仅NetType=Private时该参数有意义。
Port String 否 3306

端口号，取值范围为3000～5999。

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

返回数据

名称 类型 示例值 描述
RequestId String D0CEC6AC-7760-409A-A0D5-E6CD86******

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=ModifyDBEndpointAddress
&DBClusterId=pc-***************
&DBEndpointId=pe-****************
&NetType=Public
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyDBEndpointAddressResponse>
<RequestId>D0CEC6AC-7760-409A-A0D5-E6CD86******</RequestId>
</ModifyDBEndpointAddressResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。

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