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

调试

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

请求参数

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

系统规定参数,取值:ModifyDBEndpointAddress

DBClusterId String pc-xxxxxxxxxx

集群ID。

DBEndpointId String pe-xxxxxxxxxx

连接地址ID。例如pe-xxxxxxxx。

说明 可以通过接口DescribeDBClusterEndpoints查询。
NetType String Public

连接地址的网络类型:

  • Public:公网。
  • Private:私网。
  • Inner:私网(经典网络)。
ConnectionStringPrefix String pc-xxxxxxxxxx-pub2

新的连接地址前缀:

  • 不能以中划线(-)结尾。
  • 以字母开头,由小写字母、数字、中划线(-)组成。
  • 长度大于6个字符。
PrivateZoneAddressPrefix String xxxxxxxxxxx

私有域名前缀。

对于PolarDB的每一个私网地址,均可以绑定一个用户的私有域名,该域名仅在当前地域内指定的VPC中生效。私有域名实际上是通过PrivateZone管理的,通过CNAME映射到PolarDB自带的私网地址上,该功能PrivateZone会收取少量费用,请参见产品定价

说明NetType=Private时该参数有意义。
PrivateZoneName String xxx.com

私有域名Zone名称。

说明NetType=Private时该参数有意义。

返回数据

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

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyDBEndpointAddress
&DBClusterId=pc-xxxxxxxxxx
&DBEndpointId=pe-xxxxxxxxxx
&NetType=Public
&<公共请求参数>

正常返回示例

XML 格式

<CreateDBEndpointAddressResponse>  
      <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
</CreateDBEndpointAddressResponse>

JSON 格式

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}

错误码

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