UpdatePrivateNetworkWhiteIps - 修改实例的VPC私网访问白名单-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

接口说明

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

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:UpdateWhiteIps

update

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}

无

POST /openapi/instances/{InstanceId}/private-network-white-ips HTTP/1.1

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	es-cn-tl329rbpc0001****

名称	类型	必填	描述	示例值
clientToken	string	否	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。	5A2CFF0E-5718-45B5-9D4D-70B3FF****
modifyMode	string	否	修改方式，取值含义如下： Cover（默认值）：使用 ips 参数的值覆盖原 IP 白名单。 Append：在原 IP 白名单中增加 ips 参数中输入的 IP 地址。 Delete：在原 IP 白名单中删除 ips 参数中输入的 IP 地址，至少需要保留一个 IP 地址。	Cover
body	string	否	实例 VPC 私网访问白名单或白名单组配置。	{"privateNetworkIpWhiteList":["0.0.XX.XX","10.2.XX.XX","192.168.XX.XX/25"]}

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

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

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	6DEBE5EE-0368-4757-8F82-EF9C3972****
Result	object	返回结果。
privateNetworkIpWhiteList	array	VPC 私网访问白名单列表。
	string	VPC 私网访问白名单列表。	["192.168.XX.XX/25"]

说明

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

正常返回示例

JSON格式

{
  "RequestId": "6DEBE5EE-0368-4757-8F82-EF9C3972****",
  "Result": {
    "privateNetworkIpWhiteList": [
      "[\"192.168.XX.XX/25\"]"
    ]
  }
}

访问错误中心查看更多错误码。

更多信息，参考变更详情。