この API を呼び出して、指定した ApsaraDB for POLARDB クラスターの接続ポイント属性を変更できます。
現在、POLARDB for PostgreSQL および POLARDB for Oracle は、クラスター接続ポイントをサポートしていません。
リクエストパラメーター
パラメーター | データ型 | 必須/任意 | 説明 |
Action | String | 必須 | 実行する API ( ModifyDBClusterEndpoint) を設定します。 |
DBClusterId | String | 必須 | クラスター接続ポイントが属する ApsaraDB for POLARDB クラスターの ID を設定します。 |
EndpointId | String | 必須 | 属性を変更するクラスター接続ポイントの ID を設定します。 たとえば、pe-xxxxxxxx です。 |
ReadWriteMode | String | 任意 | クラスター接続ポイントの読み取り/書き込みモード を設定します。 設定可能な値は以下のとおりです。
既定値:ReadOnly |
Nodes | String | 任意 | この接続ポイントからの読み取りリクエストを処理するために、この接続ポイントに追加されるノードを設定します。 少なくとも 2 つのノードを追加し、それらをコンマ (,) で区切ります。 このパラメーターを指定しない場合、既定でクラスターのすべてのノードがこの接続ポイントに追加されます。 |
AutoAddNewNodes | String | 任意 | 新しく追加されたノードがこの接続ポイントに自動的に追加されるかどうかを指定します。 設定可能な値は以下のとおりです。
既定値は、Disable です。 |
EndpointConfig | String | 任意 | クラスター接続ポイントの整合性レベル を設定します。 このパラメーターは、
たとえば、 説明 ReadWriteMode パラメーターが ReadOnly に設定されている場合、このパラメーターの値は 0 でなければなりません。 |
レスポンスパラメーター
パラメーター | データ型 | 説明 |
<共通レスポンスパラメーター> | N/A | |
RequestId | String | リクエストの ID を示します。 |
リクエストの例
https://polardb.aliyuncs.com/?Action=ModifyDBClusterEndpoint
&DBClusterId=pc-xxxxxxxxxxxxxxxxxx
&EndpointId=pe-xxxxxxxxxxxxxxxxxx
&<[共通リクエストパラメーター]>レスポンスの例
XML 形式:
<ModifyDBClusterEndpointResponse>
<RequestId>CD3FA5F3-FAF3-44CA-AFFF-BAF869666D6B</RequestId>
</ModifyDBClusterEndpointResponse>JSON 形式:
{
"RequestId": "CD3FA5F3-FAF3-44CA-AFFF-BAF869666D6B"
}