全部產品
Search
文件中心

PolarDB:ModifyCustomEndpoint

更新時間:Sep 10, 2026

此介面用於修改自訂叢集地址(Custom Endpoint)的設定。

介面說明

在 PolarDB-X 中,除了預設的主地址(Primary Endpoint)和唯讀地址(Read-only Endpoint)外,使用者還可以建立自訂地址(Custom Endpoint),用於實現更靈活的讀寫分離、負載平衡或業務隔離策略。ModifyCustomEndpoint 介面允許您動態調整這些自訂地址的屬性,而無需重新啟動執行個體。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:ModifyCustomEndpoint

update

*PolarDBXInstance

acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}

無 無

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

否

執行個體所在地域。

cn-zhangjiakou

DBInstanceName

string

是

執行個體 ID。

mydatabase

CustomEndpointId

string

是

用戶端網域名稱 ID。

cep-002

Name

string

否

名稱。

secondary-endpoint

NodeIds

string

否

node ids

node3

NodeAutoEnter

boolean

否

節點在被新增或恢復後,是否自動加入叢集並開始提供服務。

true

NodeRole

string

否

節點作用。

master

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

Id of the request

1A586DCB-39A6-4050-81CC-C7BD4CCDB49F

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1A586DCB-39A6-4050-81CC-C7BD4CCDB49F"
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情。