You need to enable JavaScript to run this app.
导航
云搜索服务
  • 文档首页
    • /
  • 云搜索服务

ModifyIpWhitelist - 配置 IP 白名单

最近更新时间：2024.04.09 15:04:01

首次发布时间：2023.11.30 14:19:27

我的收藏

调用 ModifyIpWhitelist 接口，配置实例或可视化工具的访问白名单。

注意事项

Cerebro 和 Kibana/Dashboards 共用一组 IP 白名单配置，增加或删除白名单两者同时生效。

请求说明

  • 请求方式：POST
  • 请求地址：/?Action=ModifyIpWhitelist&Version=2023-01-01 HTTP/1.1

请求参数

Query

参数类型是否必选示例值描述
ActionString是ModifyIpWhitelist接口名称。当前 API 的名称为 ModifyIpWhitelist。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述

Type

String

是

public

需要配置的是公网还是私网白名单。

  • public：公网。
  • private：私网。

IpList

String

是

10.23..,10.43..

IP 白名单列表，当需要配置多个 IP 时，使用英文逗号（,）分隔。
IpList设置为空字符串时，表示清空白名单。

Component

String

是

es

需要配置白名单的对象。

  • es
  • kibana
InstanceIdString是o-0080**iu98需要修改节点配置的实例 ID

返回参数

参数类型示例值描述
StatusStringSUCCESSFUL返回的操作状态。
MessageString-返回的提示信息。

请求示例

POST https://open.volcengineapi.com/?Action=ModifyIpWhitelist&Version=2023-01-01
Content-Type: application/json
X-Date: 20231003T104027Z
Authorization: HMAC-SHA256 
Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****
{
    "Component": "es",
    "InstanceId": "o-0080**iu98",
    "IpList": "10.23..,10.43..",
    "Type": "public"
}

返回示例

{
    "Result": {
        "Status": "SUCCESSFUL",
        "Message": ""
    },
    "ResponseMetadata": {
        "Action": "ModifyIpWhitelist",
        "Region": "cn-beijing",
        "RequestId": "202306041104200100100232280**",
        "Service": "escloud",
        "Version": "2023-01-01"
    }
}