全部產品
Search
文件中心

:ModifyDBEndpointAddress - 修改叢集串連地址

更新時間:Dec 11, 2025

修改PolarDB叢集的串連地址,包括主地址、預設叢集地址、自訂叢集地址和私人網域名稱。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:ModifyDBEndpointAddress

update

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

請求參數

名稱

類型

必填

描述

樣本值

DBClusterId

string

叢集 ID。

說明

您可以通過 DescribeDBClusters 介面查看帳號下所有叢集的詳細資料,包括叢集 ID。

pc-***************

DBEndpointId

string

串連地址 ID。

說明

您可以通過介面 DescribeDBClusterEndpoints 查詢串連地址 ID。

pe-****************

NetType

string

串連地址的網路類型,取值範圍如下:

  • Public:公網

  • Private:私網

Public

ConnectionStringPrefix

string

新的串連地址首碼,需滿足如下條件:

  • 由小寫字母、數字、中劃線(-)組成。

  • 以字母開頭,以數字或字母結尾。

  • 長度為 6~30 個字元。

example

PrivateZoneAddressPrefix

string

私人網域名稱首碼。需滿足如下條件:

  • 由小寫字母、數字、中劃線(-)組成。

  • 以字母開頭,以數字或字母結尾。

  • 長度為 6~30 個字元。

說明
  • 對於 PolarDB 的每一個私網地址,均可以綁定一個使用者的私人網域名稱,該網域名稱僅在當前地區內指定的 VPC 中生效。私人網域名稱實際上是通過 PrivateZone 管理的,通過 CNAME 映射到 PolarDB 內建的私網地址上,該功能 PrivateZone 會收取少量費用,請參見產品定價

  • NetType=Private時該參數有意義。

aliyundoc

PrivateZoneName

string

私人網域名稱 Zone 名稱。

說明

NetType=Private時該參數有意義。

aliyundoc.com

Port

string

連接埠號碼,取值範圍為 3000~5999。

說明
  • 僅 PolarDB MySQL 版叢集支援該參數,若該參數留空,則預設連接埠號碼為 3306。

3306

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

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

樣本

正常返回樣本

JSON格式

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

異常返回樣本

JSON格式

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

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 DnsConflict ParamsError.DnsConflict(Dns is already used, ConnAddrCust:%s). 參數錯誤DNS衝突(DNS已經使用,串連地址:%s)。
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情