すべてのプロダクト
Search

このプロダクト

    PolarDB:ModifyDBClusterEndpoint

    ドキュメントセンター

    PolarDB:ModifyDBClusterEndpoint

    最終更新日:Sep 24, 2026

    PolarDB クラスターのクラスターエンドポイントの属性を変更します。属性には、読み書きモード、新しいノードがエンドポイントに自動的に追加されるかどうか、整合性レベル、トランザクション分割、プライマリノードが読み取りリクエストを受け入れるかどうか、およびコネクションプーリングが含まれます。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:ModifyDBClusterEndpoint

    update

    *クラスター。

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスターの ID。

    pc-*************
    DBEndpointId

    string

    必須

    クラスターエンドポイントの ID。

    pe-**************
    Nodes

    string

    任意

    対象のエンドポイントに追加する読み取り負荷ノード。複数のノードはコンマ (,) で区切ります。デフォルト値: 既存のノード。

    説明

    • PolarDB for MySQL の場合は、ノード ID を指定します。

    • PolarDB for PostgreSQL および PolarDB for PostgreSQL (Oracle 互換) の場合は、Writer,Reader1,Reader2 のようなノードロール名を指定します。

    • ReadWriteMode が ReadOnly に設定されている場合、マウントできるノードは 1 つだけです。ただし、このノードに障害が発生すると、エンドポイントが最大 1 時間使用できなくなる可能性があります。この構成は本番環境では使用しないでください。可用性を向上させるには、2 つ以上のノードを選択します。

    • ReadWriteMode が ReadWrite に設定されている場合は、2 つ以上のノードを選択します。

      • PolarDB for MySQL では、任意の 2 つのノードを選択できます。両方のノードが読み取り専用ノードである場合、書き込みリクエストはプライマリノードに転送されます。

      • PolarDB for PostgreSQL および PolarDB for PostgreSQL (Oracle 互換) では、プライマリノードを含める必要があります。

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

    string

    任意

    読み書きモード。有効な値:

    • ReadWrite: 読み書き (自動読み書き分割)

    • ReadOnly: 読み取り専用

    ReadWrite
    AutoAddNewNodes

    string

    任意

    新しいノードがエンドポイントに自動的に追加されるかどうかを指定します。有効な値:

    • Enable: 新しいノードが自動的に追加されます。

    • Disable: 新しいノードは自動的に追加されません。(デフォルト)

    列挙値:

    • Enable :

      新しいノードがエンドポイントに自動的に追加されます。

    • Disable :

      新しいノードはエンドポイントに自動的に追加されません。

    Enable
    EndpointConfig

    string

    任意

    JSON フォーマットのクラスターエンドポイントの詳細設定。整合性レベル、トランザクション分割、プライマリノードが読み取りリクエストを受け入れるかどうか、コネクションプーリング、およびその他の設定を構成できます。

    • 負荷分散ポリシーを設定するには、{"LoadBalancePolicy":"負荷分散ポリシー"} フォーマットを使用します。有効な値:

      • 0: 接続ベースの負荷分散。(デフォルト)

      • 1: アクティブなリクエストベースの負荷分散。

    • プライマリノードが読み取りリクエストを受け入れるかどうかを設定するには、{"MasterAcceptReads":"プライマリノードが読み取りを受け入れるかどうか"} フォーマットを使用します。有効な値:

      • on: プライマリノードが読み取りリクエストを受け入れます。(デフォルト)

      • off: プライマリノードは読み取りリクエストを受け入れません。

    • トランザクション分割を設定するには、{"DistributedTransaction":"トランザクション分割","TrxSplitAggressive":"トランザクション分割"} フォーマットで 2 つのパラメーターを一緒に使用します。有効な値:

      • Disabled: DistributedTransaction=off、TrxSplitAggressive=off

      • 最初の書き込みリクエスト前の読み取りリクエスト分割: DistributedTransaction=on、TrxSplitAggressive=off

      • フルトランザクション分割: DistributedTransaction=on、TrxSplitAggressive=on

    • 整合性レベルを設定するには、{"ConsistLevel":"整合性レベル"} フォーマットを使用します。有効な値:

      • 0: 結果整合性 (弱)。

      • 1: セッションの一貫性 (中間)。(デフォルト)

      • 2: グローバル整合性 (強)。

    • グローバル整合性読み取りタイムアウト期間を設定するには、{"ConsistTimeout":"グローバル整合性読み取りタイムアウト"} フォーマットを使用します。有効な値: 0～60000。デフォルト値: 20。単位: ms。

    • セッションの一貫性読み取りタイムアウト期間を設定するには、{"ConsistSessionTimeout":"セッションの一貫性読み取りタイムアウト"} フォーマットを使用します。有効な値: 0～60000。デフォルト値: 0。単位: ms。

    • グローバル (またはセッション) 整合性読み取りタイムアウトポリシーを設定するには、{"ConsistTimeoutAction":"グローバル整合性読み取りタイムアウトポリシー"} フォーマットを使用します。有効な値:

      • 0: 読み取りリクエストをプライマリノードに転送します。(デフォルト)

      • 1: プロキシがアプリケーションにエラーメッセージ レプリケーション完了待ちタイムアウト、リトライしてください を返します。

    • 接続プールを設定するには、{"ConnectionPersist":"接続プール"} フォーマットを使用します。有効な値:

      • off: 接続プールを無効にします。(デフォルト)

      • Session: セッションレベルの接続プールを有効にします。

      • Transaction: トランザクションレベルのコネクションプーリングを有効にします。

    • オンデマンド接続確立を設定するには、{"ConnectAllBackends":"オンデマンド接続"} フォーマットを使用します。有効な値:

      • on: 有効。

      • off: 無効。(デフォルト)

    • パラレルクエリを設定するには、{"MaxParallelDegree":"パラレルクエリ"} フォーマットを使用します。有効な値:

      • on: パラレルクエリを有効にします。

      • off: パラレルクエリを無効にします。(デフォルト)

    • プライマリノードからの行オフロード読み取り間の自動リクエストディストリビューションを設定するには、{"EnableHtapImci":"ローストア/列のストア自動リクエストディストリビューション"} フォーマットを使用します。有効な値:

      • on: プライマリノードからの行オフロード読み取り間の自動リクエストディストリビューションを有効にします。

      • off: プライマリノードからの行オフロード読み取り間の自動リクエストディストリビューションを無効にします。(デフォルト)

    • 過負荷保護を有効にするかどうかを設定するには、{"EnableOverloadThrottle":"過負荷保護を有効にするかどうか"} フォーマットを使用します。有効な値:

      • on: 過負荷保護を有効にします。

      • off: 過負荷保護を無効にします。(デフォルト)

    • ノードの重みを設定するには、{"NodesWeight":{"ノード ID":"重みの値"}} フォーマットを使用します。

    説明

    • トランザクション分割、プライマリノードが読み取りリクエストを受け入れるかどうか、コネクションプーリング、および過負荷保護は、PolarDB for MySQL クラスターエンドポイントの読み書きモードが 読み書き (自動読み書き分割) に設定されている場合にのみ構成できます。

    • PolarDB for MySQL クラスターエンドポイントの読み書きモードが 読み取り専用 に設定されている場合、接続ベースの負荷分散 ポリシーと アクティブなリクエストベースの負荷分散 ポリシーの両方がサポートされます。読み書き (自動読み書き分割) モードでは、アクティブなリクエストベースの負荷分散 ポリシーのみがサポートされます。

    • プライマリノードからの行オフロード読み取り間の自動リクエストディストリビューションは、PolarDB for MySQL クラスターエンドポイントの読み書きモードが 読み書き (自動読み書き分割) に設定されている場合、または読み書きモードが 読み取り専用 で負荷分散ポリシーが アクティブなリクエストベースの負荷分散 に設定されている場合に構成できます。

    • 整合性レベルをグローバル整合性に設定できるのは PolarDB for MySQL のみです。

    • ReadWriteMode が ReadOnly に設定されている場合、整合性レベルは 0 にのみ設定できます。

    • 整合性レベル、トランザクション分割、プライマリノードが読み取りリクエストを受け入れるかどうか、およびコネクションプーリングを同時に設定できます。例: {"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}。

    • トランザクション分割は整合性レベルによって制約されます。たとえば、整合性レベルが 0 に設定されている場合、トランザクション分割は有効にできません。トランザクション分割は、整合性レベルが 1 または 2 に設定されている場合に有効にできます。

    {"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}
    DBEndpointDescription

    string

    任意

    エンドポイントの名前。

    test
    SccMode

    string

    任意

    ノードのグローバル整合性 (パフォーマンススキーマ) 機能を有効にするかどうかを指定します。有効な値:

    • ON: 有効。

    • OFF: 無効。

    列挙値:

    • off :

      無効。

    • on :

      有効。

    on
    PolarSccWaitTimeout

    string

    任意

    グローバル整合性のタイムアウト期間。

    100
    PolarSccTimeoutAction

    string

    任意

    グローバル整合性のタイムアウト時間ポリシー。有効な値:

    • 0: リクエストをプライマリノードに送信します。

    • 2: タイムアウト劣化。グローバル整合性読み取りがタイムアウトすると、クエリは自動的にレギュラーリクエストに劣化し、クライアントはエラーメッセージを受信しません。

    0

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID。

    CD3FA5F3-FAF3-44CA-AFFF-BAF869******

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "CD3FA5F3-FAF3-44CA-AFFF-BAF869******"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidEndpointConfig.Malformed The specified parameter EndpointConfig is not valid. 指定されたエンドポイント設定パラメーターは無効です。
    400 InvalidDBEndpointId.Malformed The specified parameter DBEndpointId is not valid. 指定された DB エンドポイント ID パラメーターは無効です。
    400 InvalidNodes.Malformed The specified parameter Nodes is not valid. 指定されたパラメーター Nodes は無効です。
    403 OperationDenied.InstanceType The operation is not permitted due to instance type. インスタンスタイプにより、この操作は許可されていません。
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 操作に失敗しました。指定されたクラスターインスタンス ID が存在しません。
    404 EndpointStatus.NotSupport Current endpoint status does not support this operation. 現在のノードステータスでは、この操作に対応していません。
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定された DBClusterId がレコードに存在しません。
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. 指定された DBClusterId が現在のレコードに存在しません。

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。