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

接口说明

注意事项

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:UpdateWhiteIps

update

*Instance

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

无

请求语法

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

路径参数

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

请求参数

名称	类型	必填	描述	示例值
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	object	否	RequestBody 信息。
esIPWhitelist	array	否	白名单中的 IP 地址信息。
	string	否	IP 地址白名单列表。whiteIpGroup 为空时可用，该参数值会更新 Default 白名单分组中的 IP 白名单配置。重要不支持同时配置 esIPWhitelist 和 whiteIpGroup。	["10.61.xx.xx", "106.11.xx.xx”]
whiteIpGroup	object	否	以白名单组方式更新实例白名单配置，仅支持更新一个白名单组。重要不支持同时配置 esIPWhitelist 和 whiteIpGroup。
groupName	string	否	白名单组的组名。如果选填了 whiteIpGroup 参数，则该参数必填。	test_group
ips	array	否	白名单组中的 IP 地址列表。
	string	否	白名单组中的 IP 地址列表。如果选填了 whiteIpGroup 参数，则该参数必填。	["10.2.xx.xx", "10.3.xx.xx"]
whiteIpType	string	否	IP 白名单的类型。固定为PRIVATE_ES，即私网访问白名单。	PRIVATE_ES

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

modifyMode 为 Cover 时，如果 ips 为空，则删除该白名单组。如果 groupName 不在已有白名单组组名的列表中，则会新建一个白名单组。
modifyMode 为 Delete 时，删除后的 ips 至少需要保留一个 IP 地址。
modifyMode 为 Append 时，需要保证白名单组组名为已创建，否则会提示 NotFound 的错误。

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	8D58B014-BBD7-4D80-B219-00B9D5C6860C
Result	object	返回结果。
esIPWhitelist	array	私网访问白名单（已废弃）。
	string	更新后的白名单列表。	["106.11.xx.xx", "10.61.xx.xx"]
networkConfig	object	网络配置。
whiteIpGroupList	array<object>	白名单组列表。
	object	白名单组信息。
groupName	string	白名单组的组名。默认包含 default 分组。	test_group
ips	array	白名单组中的 IP 地址信息。
	string	白名单组中的 IP 地址列表。	["10.2.xx.xx", "10.3.xx.xx"]
whiteIpType	string	白名单类型。固定为 PRIVATE_ES，即私网访问白名单。	PRIVATE_ES

说明

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

示例

正常返回示例

JSON格式

{
  "RequestId": "8D58B014-BBD7-4D80-B219-00B9D5C6860C",
  "Result": {
    "esIPWhitelist": [
      "[\"106.11.xx.xx\", \"10.61.xx.xx\"]"
    ],
    "networkConfig": {
      "whiteIpGroupList": [
        {
          "groupName": "test_group",
          "ips": [
            "[\"10.2.xx.xx\", \"10.3.xx.xx\"]"
          ],
          "whiteIpType": "PRIVATE_ES"
        }
      ]
    }
  }
}

错误码

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

变更历史

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