すべてのプロダクト
Search

このプロダクト

    PolarDB:CreateDBClusterEndpoint

    ドキュメントセンター

    PolarDB:CreateDBClusterEndpoint

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

    create

    *DBCluster。

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

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

    string

    必須

    カスタムクラスターエンドポイントのタイプ。有効な値:

    • Custom: カスタムクラスターエンドポイント。

    • DynamoDB: DynamoDB エンドポイント。

    Custom
    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 (デフォルト): 読み取り専用。

    ReadOnly
    AutoAddNewNodes

    string

    任意

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

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

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

    列挙値:

    • 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 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 の場合、トランザクション分割を有効にできます。

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

    string

    任意

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

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

    string

    任意

    カスタムクラスターエンドポイントの名前。

    test
    VPCId

    string

    任意

    VPC ID。

    vpc-2zehr7ghqovftils0****
    VSwitchId

    string

    任意

    vSwitch ID。

    vsw-2ze775gnf7jn33ua****
    SccMode

    string

    任意

    ノードのグローバル整合性 (高性能モード) の特徴を有効にするかどうかを指定します。有効な値:

    • ON: 有効。

    • OFF: 無効。

    列挙値:

    • off :

      無効。

    • on :

      有効。

    on
    PolarSccWaitTimeout

    string

    任意

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

    100
    PolarSccTimeoutAction

    string

    任意

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

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

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

    0
    PolarFsInstanceId

    string

    任意

    PolarFs インスタンス ID。

    pfs-test****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

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

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    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. 指定された DBClusterId が現在のレコードに存在しません。
    404 EndpointConfig.Conflict Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled. エンドポイントの構成が無効です。ノードに対してグローバル整合性 (高パフォーマンスモード) が有効になっているため、CausalConsistRead はセッションに設定する必要があります。

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

    変更履歴

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