すべてのプロダクト
Search
ドキュメントセンター

:CreateDBClusterEndpoint

最終更新日:Oct 14, 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:CreateDBClusterEndpoint

create

*DBCluster

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBClusterId

string

必須

クラスターの ID。

pc-**************

EndpointType

string

必須

カスタムクラスターエンドポイントのタイプ。値を Custom に設定します。

Custom

Nodes

string

任意

エンドポイントに追加するノード。複数のノード ID はコンマ (,) で区切ります。デフォルトでは、すべてのノードが追加されます。

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

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

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

  • ReadWriteModeReadWrite に設定した場合は、少なくとも 2 つのノードを追加する必要があります。 * PolarDB for MySQL の場合は、任意の 2 つのノードを選択できます。両方のノードが読み取り専用ノードの場合、書き込みリクエストはプライマリノードに送信されます。 * PolarDB for PostgreSQL および PolarDB for PostgreSQL (Oracle 互換) の場合は、プライマリノードを含める必要があります。

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

ReadWriteMode

string

任意

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

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

  • ReadOnly (デフォルト): 読み取り専用。

ReadOnly

AutoAddNewNodes

string

任意

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

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

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

Disable

EndpointConfig

string

任意

クラスターエンドポイントの詳細設定。値は JSON 文字列です。整合性レベル、トランザクション分割、接続プール、およびプライマリノードから読み取りをオフロードするかどうかを設定できます。

  • 負荷分散ポリシーを設定します。フォーマットは {"LoadBalancePolicy":"policy"} です。有効な値:
    • 0: 接続ベースの負荷分散 (デフォルト)。

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

  • 整合性レベルを設定します。フォーマットは {"ConsistLevel":"level"} です。有効な値:
    • 0: 最終的な整合性。

    • 1: セッション整合性 (デフォルト)。

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

  • トランザクション分割を設定します。フォーマットは {"DistributedTransaction":"status"} です。有効な値:
    • on: トランザクション分割を有効にします (デフォルト)。

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

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

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

  • 接続プールを設定します。フォーマットは {"ConnectionPersist":"pool"} です。有効な値:
    • off: 接続プールを無効にします (デフォルト)。

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

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

  • パラレルクエリを設定します。フォーマットは {"MaxParallelDegree":"degree"} です。有効な値:
    • 特定の並列処理の次数。例: "MaxParallelDegree":"2"。

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

  • ローストアと列ストア間の自動ルーティングを設定します。フォーマットは {"EnableHtapImci":"status"} です。有効な値:
    • on: ローストアと列ストア間の自動ルーティングを有効にします。

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

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

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

説明
  • トランザクション分割、プライマリノードからの読み取りのオフロード、接続プール、および過負荷保護は、PolarDB for MySQL のクラスターエンドポイントの読み書きモードが ReadWrite (自動読み書き分離) に設定されている場合にのみ設定できます。

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

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

  • PolarDB for MySQL のみがグローバル整合性をサポートします。

  • ReadWriteModeReadOnly に設定した場合、整合性レベルは 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

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエストの ID。

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

成功レスポンス

JSONJSON

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

エラーレスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 ClusterEndpoint.StatusNotValid Cluster endpoint status is not valid.
400 EndpointNum.Error Endpoint number error.
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.
404 EndpointConfig.Conflict Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.

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

変更履歴

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