全部產品
Search

搜尋本產品

    ：CreateDBClusterEndpoint - 建立自訂叢集地址

    文件中心

    ：CreateDBClusterEndpoint - 建立自訂叢集地址

    更新時間：Oct 14, 2025

    建立PolarDB自訂叢集地址。

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:CreateDBClusterEndpoint

    create

    *DBCluster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBClusterId

    string

    是

    叢集 ID。

    pc-**************
    EndpointType

    string

    是

    自訂叢集地址類型，取值固定為 Custom。

    Custom
    Nodes

    string

    否

    加入目標地址的讀負載節點，多個節點間用英文逗號（,）分隔。 預設為全部節點。

    說明

    • PolarDB MySQL 版需要傳入節點 ID。

    • PolarDB PostgreSQL 版和 PolarDB PostgreSQL 版（相容 Oracle）需要傳入節點角色名稱，例如Writer,Reader1,Reader2。

    • ReadWriteMode 取值為 ReadOnly 時，支援只掛載一個節點。但當此節點故障時，該地址可能會有最多 1 小時的不可用，請勿用於生產環境。因此，推薦至少選擇 2 個節點，以提升可用性。

    • ReadWriteMode 取值為 ReadWrite 時，至少要選擇 2 個節點。 * PolarDB MySQL 版支援選擇任意兩個節點。當兩個節點都是唯讀節點時，寫請求都會發往主節點。 * PolarDB PostgreSQL 版和 PolarDB PostgreSQL 版（相容 Oracle）必須包含主節點。

    pi-**********,pi-*********
    ReadWriteMode

    string

    否

    讀寫入模式，取值範圍如下：

    • ReadWrite：可讀可寫（自動讀寫分離）。

    • ReadOnly（預設）：唯讀。

    ReadOnly
    AutoAddNewNodes

    string

    否

    新節點是否自動加入本地址，取值範圍如下：

    • Enable：新節點自動加入本地址。

    • Disable（預設）：新節點不自動加入本地址。

    Disable
    EndpointConfig

    string

    否

    叢集地址的進階配置，格式為 JSON，目前支援設定一致性層級、事務拆分、主庫不接受讀和串連池。

    • 設定負載平衡策略。格式為{"LoadBalancePolicy":"負載平衡策略"}。取值範圍如下：

      • 0：基於串連數負載平衡（預設）。

      • 1：基於活躍請求數負載平衡。

    • 設定一致性層級。格式為{"ConsistLevel":"一致性層級"}，取值範圍如下：

      • 0：最終一致性。

      • 1：會話一致性（預設值）。

      • 2：全域一致性。

    • 設定事務拆分。格式為{"DistributedTransaction":"事務拆分"}，取值範圍如下：

      • on：開啟事務拆分（預設值）。

      • off：關閉事務拆分。

    • 設定主庫是否接受讀。格式為{"MasterAcceptReads":"主庫不接受讀"}，取值範圍如下：

      • on：表示主庫接受讀。

      • off：表示主庫不接受讀（預設值）。

    • 設定串連池。格式為{"ConnectionPersist":"串連池"}，取值範圍如下：

      • off：關閉串連池（預設值）。

      • Session：開啟會話級串連池。

      • Transaction：開啟事務級串連池。

    • 設定並行查詢，格式為{"MaxParallelDegree":"並行查詢"}。取值範圍如下：

      • 具體的並發數量。樣本："MaxParallelDegree":"2"。

      • off：關閉並行查詢（預設）。

    • 設定行存/列存自動引流，格式為{"EnableHtapImci":"行存/列存自動引流"}。取值範圍如下：

      • on：開啟行存/列存自動引流功能。

      • off：關閉行存/列存自動引流功能（預設）。

    • 設定是否開啟過載保護，格式為{"EnableOverloadThrottle":"是否開啟過載保護"}。取值範圍如下：

      • on：開啟過載保護。

      • off：關閉過載保護（預設）。

    說明

    • 僅當 PolarDB MySQL 版叢集地址的讀寫入模式為**可讀可寫（自動讀寫分離）**時，支援設定事務拆分、主庫是否接受讀、串連池和是否開啟過載保護。

    • 當 PolarDB MySQL 版叢集地址的讀寫入模式為唯讀時，支援基於串連數負載平衡和基於活躍請求數負載平衡兩種負載平衡策略； 可讀可寫（自動讀寫分離）模式的叢集地址僅支援基於活躍請求數負載平衡策略。

    • 當 PolarDB MySQL 版叢集地址的讀寫入模式為可讀可寫（自動讀寫分離），或叢集地址的讀寫入模式為唯讀且負載平衡策略為基於活躍請求數負載平衡時，支援設定行存/列存自動引流。

    • 僅 PolarDB MySQL 版支援將一致性層級設定為全域一致性。

    • 如果參數 ReadWriteMode 取值為 ReadOnly，一致性層級取值只能為 0。

    • 您可以同時設定一致性層級、事務拆分、主庫不接受讀和串連池，例如{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}。

    • 事務拆分的設定受一致性層級設定的約束。例如一致性層級取值為 0 時，不支援開啟事務拆分；一致性層級取值為 1 或 2 時，支援開啟事務拆分。

    {"ConsistLevel": "1","DistributedTransaction": "on"}
    ClientToken

    string

    否

    用於保證請求的等冪性，防止重複提交請求。由用戶端產生該參數值，保證在不同請求間唯一，大小寫敏感、不超過 64 個 ASCII 字元。

    6000170000591aed949d0f******************
    DBEndpointDescription

    string

    否

    自訂叢集位址名稱。

    test
    SccMode

    string

    否

    節點是否開啟全域一致性（高效能模式）功能。取值範圍如下：

    • ON：開啟

    • OFF：關閉

    on
    PolarSccWaitTimeout

    string

    否

    全域一致性逾時時間

    100
    PolarSccTimeoutAction

    string

    否

    全域一致性逾時策略。取值範圍如下：

    • 0：發送該請求到主節點

    • 2：逾時降級，當全域一致性讀逾時後，本次查詢操作會自動降級為非一致性讀取，且用戶端不會收到報錯資訊

    0
    PolarFsInstanceId

    string

    否

    pfs-test****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    CD35F3-F3-44CA-AFFF-BAF869******

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "CD35F3-F3-44CA-AFFF-BAF869******"
}

    異常返回樣本

    JSON格式

    {
    "RequestId": "CD35F3-F3-44CA-AFFF-BAF869666D6B"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 ClusterEndpoint.StatusNotValid Cluster endpoint status is not valid. 叢集地址的狀態無效.
    400 EndpointNum.Error Endpoint number error. Endpoint數量超過限制
    400 LockTimeout The request processing has failed due to lock timeout. 由於鎖定逾時，請求處理失敗
    403 OperationDenied.InstanceType The operation is not permitted due to instance type. 由於執行個體類型的原因，不允許執行該操作
    404 EndpointConfig.Invalid Endpoint config is invalid. 叢集地址的進階配置參數無效
    404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的 DBClusterId。
    404 EndpointConfig.Conflict Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled. Endpoint配置無效，CausalConsistRead應為會話，因為節點的全域一致性（高效能模式）已啟用。

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

    變更歷史

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