UpdateWhiteIps_Elasticsearch_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

注意事项

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

流控信息

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

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
elasticsearch:UpdateWhiteIps
Update
Instance
acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}

请求语法

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

路径参数

字段名称字段详情
InstanceIdstring

实例 ID。

示例值:es-cn-npk2154oi000b****参考取值来源:
    ListInstance

请求参数

字段名称字段详情
clientTokenstring

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。

示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
modifyModestring

修改方式,可选值:展开详情

示例值:Cover
bodyobject

RequestBody 信息。

请求说明

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

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

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:8D58B014-BBD7-4D80-B219-00B9D5C6860C
Resultobject

返回结果。

返回说明

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

返回示例

变更历史

暂无变更历史

相关示例