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

调试

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

请求参数

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

系统规定参数,取值为ModifyDBEndpointAddress

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

集群ID。

DBEndpointId String pe-****************

连接地址ID。

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

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

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

仅PolarDB MySQL集群支持私网(经典网络)类型。

ConnectionStringPrefix String test-1

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

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

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

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

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

JSON 格式

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

错误码

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