找不到 API ? 点击 反馈吧
- APM
- 实例
- 索引管理
- 释放指定按量付费类型的实例DeleteInstance
- 转换付费类型UpdateInstanceChargeType
- 更改实例名称UpdateDescription
- 开启或关闭集群写入高可用特性UpdateReadWritePolicy
- 更新集群弹性扩缩容规则ModifyElastictask
- 更改并开启实例的可维护时间ModifyInstanceMaintainTime
- 更新实例Kibana访问白名单UpdateKibanaWhiteIps
- 修改实例的VPC私网访问白名单UpdateWhiteIps
- ES实例列表信息ListInstance
- 查看实例详情DescribeInstance
- 获取区域信息DescribeRegions
- ES实例节点信息ListAllNode
- 获取集群弹性扩缩容规则GetElastictask
- 获取集群的索引列表ListInstanceIndices
- 创建ES实例createInstance
- 实例重启预估时间EstimatedRestartTime
- 重启ElasticsearchRestartInstance
- ES实例续费RenewInstance
- 恢复已下线的可用区ActivateZones
- 下线部分可用区DeactivateZones
- 中断变更中的实例InterruptElasticsearchTask
- 恢复中断变更ResumeElasticsearchTask
- 迁移可用区MigrateToOtherZone
- 恢复释放后被冻结的实例CancelDeletion
- 诊断实例DiagnoseInstance
- 修改实例资源组MoveResourceGroup
- 容量规划CapacityPlan
- 查看OpenStore实例用量GetOpenStoreUsage
- 查看词典列表详情ListDicts
- 分片恢复数据列表ListShardRecoveries
- 标签
- 数据迁移
- 采集器
- 实例升降配
- 集群配置
- 插件管理
- 集群监控
- 日志查询
- 安全配置
- 数据备份
- 智能运维
- Kibana
- Logstash
- 其他
UpdateKibanaWhiteIps
更新指定阿里云Elasticsearch实例的Kibana访问白名单
服务地址:
华东1 金融云
文档
调用结果
SDK 示例
CLI示例
相关示例
调用历史
错误码
流控
插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
接口说明
注意事项
- 调用该接口时,当实例状态为生效中(activating)、失效(invalid)和冻结(inactive)时,无法更新信息。
- 您可以通过两种方式更新白名单:IP 白名单列表和 IP 白名单组。两种方式不能同时使用,且除了 InstanceId 和 clientToken 外,两种方式支持配置的参数也不同,具体如下:
- IP 白名单列表:kibanaIPWhitelist
- IP 白名单组:modifyMode、whiteIpGroup
- 公网访问白名单不支持配置私网 IP 地址,私网访问白名单不支持配置公网 IP 地址。
请求语法
PATCH /openapi/instances/{InstanceId}/kibana-white-ips HTTP/1.1
POST /openapi/instances/{InstanceId}/kibana-white-ips HTTP/1.1
路径参数
字段名称 | 字段详情 |
---|---|
InstanceIdstring | 实例 ID。 示例值:es-cn-tl329rbpc0001****参考取值来源: ListInstance |
请求参数
字段名称 | 字段详情 |
---|---|
clientTokenstring | 用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不值过 64 个 ASCII 字符。 示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
modifyModestring | 修改方式,取值含义如下:展开详情 示例值:Cover枚举值:CoverAppendDelete |
bodyobject | 请求体。 |
请求说明
注意 白名单组的增加和删除是由 modifyMode 为 Cover 的调用来实现的,Delete 和 Append 无法实现白名单组粒度的增删,只能修改白名单组中的 IP 地址列表。具体说明如下:
- modifyMode 为 Cover 时,如果 ips 为空,则删除该白名单组。如果 groupName 不在已有白名单组组名的列表中,则会新建一个白名单组。
- modifyMode 为 Delete 时,删除后的 ips 至少需要保留一个 IP 地址。
- modifyMode 为 Append 时,需要保证白名单组组名为已创建,否则会提示 NotFound 的错误。
返回参数
字段名称 | 字段详情 |
---|---|
RequestIdstring | 请求 ID。 示例值:E5EF11F1-DBAE-4020-AC24-DFA6C4345CAE |
Resultobject | 返回对应 Elasticsearch 实例的详情。 |
返回说明
说明
下文返回示例中,本文只保证包含返回数据列表中的参数,而未提到的参数仅供参考,程序中不能强制依赖获取这些参数。
变更历史
变更时间 | 变更内容概要 | 操作 | |
---|---|---|---|
2022-09-13 | 变更请求参数modifyMode 新增请求参数body 变更返回参数 | ||
2022-08-30 | 删除错误码400 |