ModifyWhiteIps_Elasticsearch_API文档-阿里云OpenAPI开发者门户

接口说明

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

当前云产品API请求速率暂未透出。

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

elasticsearch:ModifyWhiteIps	Update	Instance acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}	无	无

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

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

字段名称	字段详情
clientTokenstring	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ascii 字符。示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
bodyobject	请求体参数。

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

字段名称	字段详情
Resultboolean	返回结果：展开详情示例值:true
RequestIdstring	请求 ID。示例值:5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG

	变更时间	变更内容概要	操作
	2022-01-18	删除请求参数nodeType 删除请求参数networkType 删除请求参数modifyMode 删除请求参数whiteIpList 删除请求参数whiteIpGroup 新增请求参数body