すべてのプロダクト
Search

このプロダクト

    PolarDB:ModifyDBClusterEndpointZonal

    ドキュメントセンター

    PolarDB:ModifyDBClusterEndpointZonal

    最終更新日:Oct 27, 2025

    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:ModifyDBClusterEndpointZonal

    update

    *All Resource

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

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

    string

    必須

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

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

    string

    任意

    エンドポイントに追加する読み取り専用ノード。複数のノード ID はコンマ (,) で区切ります。このパラメーターを指定しない場合、元のノードが保持されます。

    説明

    • 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
    EndpointConfig

    string

    任意

    クラスターエンドポイントの詳細設定。JSON 形式で指定します。整合性レベル、トランザクション分割、プライマリノードが読み取りリクエストを受け入れるかどうか、接続プールなどを設定できます。

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

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

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

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

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

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

    • トランザクション分割を構成するには、{\"DistributedTransaction\":\"value\"} のフォーマットを使用します。有効な値:

      • on: トランザクション分割を有効にします (デフォルト)

      • off: トランザクション分割を無効にします

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

      • 0: 最終的な整合性 (弱)

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

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

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

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

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

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

      • 1: プロキシは `wait replication complete timeout, please retry` というエラーメッセージをアプリケーションに返します。

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

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

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

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

    • 並列クエリを構成するには、{\"MaxParallelDegree\":\"value\"} のフォーマットを使用します。有効な値:

      • on: 並列クエリを有効にします

      • off: 並列クエリを無効にします (デフォルト)

    • ローストアと列ストア間の自動ルーティングを構成するには、{\"EnableHtapImci\":\"value\"} のフォーマットを使用します。有効な値:

      • on: ローストアと列ストア間の自動ルーティングを有効にします

      • off: ローストアと列ストア間の自動ルーティングを無効にします (デフォルト)

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

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

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

    説明

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

    • PolarDB for MySQL のクラスターエンドポイントの読み書きモードが ReadOnly の場合、接続ベースとアクティブリクエストベースの両方の負荷分散ポリシーがサポートされます。読み書きモードが ReadWrite (自動読み書き分離) の場合、アクティブリクエストベースの負荷分散ポリシーのみがサポートされます。

    • ローストアと列ストア間の自動ルーティングは、PolarDB for MySQL のクラスターエンドポイントの読み書きモードが ReadWrite (自動読み書き分離) の場合、または読み書きモードが ReadOnly で負荷分散ポリシーがアクティブリクエストベースの場合に構成できます。

    • グローバル整合性レベルをサポートしているのは PolarDB for MySQL のみです。

    • ReadWriteMode を ReadOnly に設定した場合、整合性レベルは 0 にしか設定できません。

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

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

    {\"DistributedTransaction\":\"off\",\"ConsistLevel\":\"0\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\"}
    DBEndpointDescription

    string

    任意

    エンドポイントの名前。

    test
    SccMode

    string

    任意

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

    • ON: 機能を有効にします

    • OFF: 機能を無効にします

    OFF
    PolarSccWaitTimeout

    string

    任意

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

    100
    PolarSccTimeoutAction

    string

    任意

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

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

    • 2: タイムアウトのスペックダウン。グローバル整合性読み取りがタイムアウトした場合、クエリは自動的に通常のリクエストにスペックダウンされ、クライアントはエラーメッセージを受信しません。

    0
    ClientToken

    string

    任意

    リクエストのべき等性を保証するためのクライアントトークン。クライアントが値を生成しますが、異なるリクエスト間で値が一意であることを確認する必要があります。トークンは大文字と小文字を区別し、最大 64 の ASCII 文字を含めることができます。

    6000170000591aed949d0f******************

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター

    RequestId

    string

    リクエスト ID。

    F2A9EFA7-915F-4572-8299-85A307******

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "F2A9EFA7-915F-4572-8299-85A307******"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidEndpointConfig.Malformed The specified parameter EndpointConfig is not valid.
    400 InvalidDBEndpointId.Malformed The specified parameter DBEndpointId is not valid.
    400 InvalidNodes.Malformed The specified parameter Nodes is not valid.
    403 OperationDenied.InstanceType The operation is not permitted due to instance type.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records.
    404 EndpointStatus.NotSupport Current endpoint status does not support this operation.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records.

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

    変更履歴

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