UpdatePublicWhiteIps_Elasticsearch_API调试-阿里云OpenAPI开发者门户

接口说明

当实例状态为生效中（activating）、失效（invalid）和冻结（inactive）时，无法更新实例的公网地址访问白名单。
您可以通过两种方式更新白名单：IP 白名单列表和 IP 白名单组。两种方式不能同时使用，且除了 InstanceId 和 clientToken 外，两种方式支持配置的参数也不同，具体如下：
- IP 白名单列表：publicIpWhitelist
- IP 白名单组：modifyMode、whiteIpGroup
公网访问白名单不支持配置私网 IP 地址，私网访问白名单不支持配置公网 IP 地址。

PATCH /openapi/instances/{InstanceId}/public-white-ips HTTP/1.1
POST /openapi/instances/{InstanceId}/public-white-ips HTTP/1.1

字段名称	字段详情
InstanceIdstring	实例 ID。示例值:es-cn-tl329rbpc0001****参考取值来源: ListInstance

字段名称	字段详情
clientTokenstring	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
modifyModestring	修改方式，取值含义如下：展开详情示例值:Cover
bodystring

参数	类型	是否必选	示例值	描述
publicIpWhitelist	List	是	["0.0.0.0/0","0.0.0.0/1"]	IP 地址白名单列表。whiteIpGroup 为空时可用，该参数值会更新 Default 白名单分组中的 IP 白名单配置。不支持同时配置 publicIpWhitelist 和 whiteIpGroup。
whiteIpGroup	Object	否		以白名单组方式更新实例白名单配置，仅支持更新一个白名单组。不支持同时配置 publicIpWhitelist 和 whiteIpGroup。
└ groupName	String	否	test_group_name	白名单组的组名。如果选填了 whiteIpGroup 参数，则该参数必填。
└ ips	List	否	["0.0.0.0", "10.2.XX.XX"]	白名单组中的 IP 列表。如果选填了 whiteIpGroup 参数，则该参数必填。

注意白名单组的增加和删除是由 modifyMode 为 Cover 的调用来实现的，Delete 和 Append 无法实现白名单组粒度的增删，只能修改白名单组中的 IP 地址列表。具体说明如下：

字段名称	字段详情
RequestIdstring	请求 ID。示例值:C82758DD-282F-4D48-934F-92170A33****
Resultobject	返回结果。

说明下文返回示例中，本文只保证包含返回数据列表中的参数，而未提到的参数仅供参考，参数说明请参见 ListInstance 。程序中不能强制依赖获取这些参数。

变更历史

	变更时间	变更内容概要	操作
	2022-08-30	删除错误码400