修改PolarDB集群的連接地址,包括主地址、默認集群地址、自定義集群地址和私有域名。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
polardb:ModifyDBEndpointAddress | Write |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 說明
您可以通過 DescribeDBClusters 接口查看賬號下所有集群的詳細信息,包括集群 ID。
| pc-*************** |
DBEndpointId | string | 是 | 連接地址 ID。 說明
您可以通過接口 DescribeDBClusterEndpoints 查詢連接地址 ID。
| pe-**************** |
NetType | string | 是 | 連接地址的網絡類型,取值范圍如下:
僅 PolarDB MySQL 版集群支持經典網絡類型。 | Public |
ConnectionStringPrefix | string | 否 | 新的連接地址前綴,需滿足如下條件:
| example |
PrivateZoneAddressPrefix | string | 否 | 私有域名前綴。需滿足如下條件:
說明
| aliyundoc |
PrivateZoneName | string | 否 | 私有域名 Zone 名稱。 說明
僅NetType=Private時該參數有意義。
| aliyundoc.com |
Port | string | 否 | 端口號,取值范圍為 3000~5999。 說明
| 3306 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}
錯誤碼
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。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2023-12-12 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||
|