ModifyWhiteIps - Elasticsearch - Alibaba Cloud ドキュメントセンター

指定した Elasticsearch クラスタの IP アドレスホワイトリストを更新します。

使用上の注意

インスタンスが Active（アクティブ化中）、Invalid（無効）、および Inactive（非アクティブ）状態の場合は更新できません。
ホワイトリストは、IP アドレスホワイトリストと IP アドレスホワイトリストグループの 2 つの方法で更新できます。 2 つの方法は同時には使用できません。 InstanceId と clientToken に加えて、2 つのメソッドは以下のように異なるパラメータをサポートしています。
- IP アドレスホワイトリスト: whiteIpList、nodeType、および networkType
- IP アドレスホワイトリストグループ: modifyMode および whiteIpGroup
パブリックネットワークアクセスホワイトリストは、プライベート IP アドレスの構成をサポートしていません。プライベートネットワークアクセスホワイトリストは、パブリック IP アドレスの構成をサポートしていません。

デバッグ

OpenAPI エクスプローラーは署名値を自動的に計算します。便宜上、OpenAPI エクスプローラーでこの操作を呼び出すことをお勧めします。 OpenAPI エクスプローラーは、異なる SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作では、共通のリクエストヘッダーのみを使用します。詳細については、共通リクエストパラメータのドキュメントを参照してください。

リクエスト構文

PATCHPOST /openapi/instances/{InstanceId}/actions/modify-white-ips HTTP/1.1

リクエストパラメータ

パラメータ	タイプ	場所	必須	例	説明
InstanceId	String	Path	はい	es-cn-0pp1jxvcl000z****	インスタンス ID。
clientToken	String	Query	いいえ	5A2CFF0E-5718-45B5-9D4D-70B3FF****	リクエストのべき等性を確保するために使用されるクライアントトークン。このパラメータの値はクライアントによって生成され、異なるリクエスト間で一意である必要があります。値は最大 64 ASCII 文字です。
	Object	Body	いいえ		リクエストボディパラメータ。
nodeType	String	Body	いいえ	WORKER	ノードのタイプ。 whiteIpList パラメータがオプションの場合は、このパラメータが必要です。有効な値: WORKER: Elasticsearch クラスタ KIBANA: Kibana クラスタ
networkType	String	Body	いいえ	PUBLIC	ネットワークタイプ。 whiteIpList パラメータがオプションの場合は、このパラメータが必要です。有効な値: PRIVATE: プライベートネットワーク PUBLIC: パブリックネットワーク
modifyMode	String	Body	いいえ	Cover	変更方法。有効な値: Cover (デフォルト): ips パラメータの値で元の IP アドレスホワイトリストを上書きします。 Append: ips パラメータに入力された IP アドレスを元の IP アドレスホワイトリストに追加します。 Delete: 元の IP アドレスホワイトリストから ips パラメータに入力された IP アドレスを削除します。少なくとも 1 つの IP アドレスを保持する必要があります。
whiteIpList	String の配列	Body	いいえ	192.168.xx.xx	IP アドレスホワイトリストのリスト。このパラメータは、whiteIpGroup が空の場合に利用可能です。このパラメータの値は、デフォルトのホワイトリストグループの IP アドレスホワイトリスト構成を更新します。重要 whiteIpList と whiteIpGroup を同時に構成することはできません。
whiteIpGroup	Object	Body	いいえ		ホワイトリストグループを使用して、インスタンスのホワイトリスト構成を更新できます。更新できるホワイトリストグループは 1 つだけです。重要 whiteIpList と whiteIpGroup を同時に構成することはできません。
groupName	String	Body	いいえ	test_group	ホワイトリストグループのグループ名。 whiteIpGroup パラメータがオプションの場合は、このパラメータが必要です。
ips	String の配列	Body	いいえ	192.168.xx.xx	ホワイトリストグループの IP アドレスのリスト。 whiteIpGroup パラメータがオプションの場合は、このパラメータが必要です。
whiteIpType	String	Body	いいえ	PRIVATE_ES	IP アドレスホワイトリストのタイプ。有効な値: PRIVATE_KIBANA: Kibana の IP アドレスホワイトリスト PRIVATE_ES: Elasticsearch プライベートネットワークアクセスホワイトリスト PUBLIC_ES: Elasticsearch インターネットアクセスホワイトリスト PUBLIC_KIBANA: Kibana のパブリック IP アドレスホワイトリスト

重要ホワイトリストグループの追加と削除は、modifyMode を Cover に呼び出すことによって実装されます。 Delete と Append は、ホワイトリストグループを同時に追加または削除できません。ホワイトリストグループの IP アドレスリストのみを変更できます。以下の項目に注意してください。

modifyMode パラメータが Cover に設定されている場合、ips が空の場合、ホワイトリストグループは削除されます。 groupName が既存のホワイトリストグループ名のリストにない場合は、ホワイトリストグループが作成されます。
modifyMode パラメータが Delete に設定されている場合、削除された ips に少なくとも 1 つの IP アドレスを保持する必要があります。
modifyMode パラメータが Append に設定されている場合、ホワイトリストグループ名が作成されていることを確認してください。そうでない場合、NotFound エラーメッセージが表示されます。

レスポンスパラメータ

パラメータ

タイプ

例

説明

Result

Boolean

true

レスポンス:

true: ホワイトリストが更新されました。
false: ホワイトリストの更新に失敗しました。

RequestId

String

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG

リクエスト ID。

例

リクエストの例

PATCH /openapi/instances/es-cn-0pp1jxvcl000z****/actions/modify-white-ips HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
    "nodeType" : "WORKER",
    "networkType" : "PUBLIC",
    "whiteIpList": [
        "110.0.XX.XX/8"
    ]
}
or
{
    "modifyMode": "cover",
    "whiteIpGroup": {
        "groupName": "test_group_name", 
        "ips": [
            "0.0.0.0", 
            "10.2.XX.XX"
        ],
        "whiteIpType" : "PRIVATE_ES"
    }
}

成功レスポンスの例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyWhiteIpsResponse>
    <Result>true</Result>
    <RequestId>5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG</RequestId>
</ModifyWhiteIpsResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG"
}

エラーコード

API エラーセンターにアクセスして、エラーコードのリストをご確認ください。