この操作では、指定した ApsaraDB for POLARDB クラスターにカスタムエンドポイントを作成します。

POLARDB for PostgreSQL または Oracle と互換性のある POLARDB クラスターのエンドポイントをカスタマイズすることはできません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須 / 任意 説明
Action String 任意 CreateDBClusterEndpoint

実行する操作。 値を CreateDBClusterEndpoint に設定します。

DBClusterId String 必須 pc-xxxxxxxxxxxxxxxxxx

クラスターの ID。

EndpointType String 必須 Custom

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

Nodes String 任意 pi-bpxxxxxxxx,pi-bpxxxxxxxx

このエンドポイントからの読み取りリクエストを処理するために、このエンドポイントに追加されるノード。 複数ある場合、コンマ (,) で区切ります。 このパラメーターを指定しない場合、デフォルトでクラスターにあるすべてのノードがこのエンドポイントに追加されます。

  • ReadWriteMode パラメーターが ReadOnly に設定されている場合、マウントできるノードは 1 つだけです。 ただし、ノードを 1 つだけ選択した場合にそのノードに障害が発生すると、このクラスターエンドポイントは最大 1 時間使用できなくなる場合があります。 本番環境ではノードを複数選択してください。 可用性向上のため、ノードを 2 つ以上選択することを推奨します。
  • ReadWriteMode パラメーターが ReadWrite に設定されている場合、ノードを 2 つ以上選択する必要があります。
  • 書き込みリクエストはプライマリノードにのみ送信されます。
ReadWriteMode String 任意 ReadOnly

エンドポイントの読み取り/書き込みモード。 設定可能な値は以下のとおりです。

  • ReadWrite: 読み取りリクエストおよび書き込みリクエストを受信して転送します (読み取り/書き込みを自動分離)。
  • ReadOnly: 読み取り専用。

    デフォルト値: ReadOnly

AutoAddNewNodes String 任意 Disable

このエンドポイントに新しく追加されたノードを自動的に追加するかどうかを指定します。 設定可能な値は以下のとおりです。

  • Enable
  • Disable

デフォルト値: Disable

EndpointConfig String 任意 {"ConsistLevel": "1","DistributedTransaction": "on"}

JSON 形式のクラスターエンドポイントの詳細構成。 現在、整合性レベルとトランザクション分割を設定できます。

次の形式で整合性レベルを設定します。 {"ConsistLevel": "Consistency level"}

設定可能な値は以下のとおりです。

  • 0: 最終的な整合性
  • 1: セッション整合性。 この値がデフォルトです。

トランザクション分割を次の形式で設定します。 {"DistributedTransaction": "Transaction splitting settings"}

設定可能な値は以下のとおりです。

  • on: トランザクション分割を有効化します。 この値がデフォルトです。
  • off: トランザクション分割を無効化します。
  • ReadWriteMode パラメーターが ReadOnly に設定されている場合、整合性レベルの値は 0 にする必要があります。
  • 整合性レベルとトランザクション分割を同時に設定できます (例:{"ConsistLevel": "1","DistributedTransaction": "on"})。
  • トランザクション分割設定は、整合性レベル設定によって制限されます。 たとえば、整合性レベルパラメーターが 0 に設定されている場合、トランザクション分割を有効化することはできません。 整合性レベルパラメーターが 1 に設定されている場合、トランザクション分割を有効化できます。
ClientToken String 任意 6000170000591aed949d0f54a343f1a4233c1e7d1c5ca816bf

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

レスポンスパラメーター

パラメーター データ型 説明
RequestId String CD35F3-F3-44CA-AFFF-BAF869666D6B

リクエストの ID 。

リクエストの例

http(s)://[Endpoint]/? Action=CreateDBClusterEndpoint
&DBClusterId=pc-xxxxxxxxxxxxxxxxxx
&EndpointType=Custom
&<共通リクエストパラメーター>

正常なレスポンスの例

JSON 形式

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

XML 形式

<CreateDBClusterEndpointResponse>  
      <RequestId>CD35F3-F3-44CA-AFFF-BAF869666D6B</RequestId>
</CreateDBClusterEndpointResponse>

エラーコード

エラーコードについては、「API エラーセンター」をご参照ください。