创建或更新 IP 地理位置数据库配置 API

编辑

创建或更新 IP 地理位置数据库配置 API

编辑

创建或更新 IP 地理位置数据库配置。

下面显示的 Maxmind account_id 需要许可证密钥。由于许可证密钥是敏感信息,因此它作为 Elasticsearch 中名为 ingest.geoip.downloader.maxmind.license_key安全设置存储。每个 Elasticsearch 集群当前仅允许一个 Maxmind 许可证密钥。要从 Maxmind 下载,安全设置中必须包含有效的许可证密钥。许可证密钥设置在所有节点重新启动或执行reload_secure_settings请求之前不会生效。

PUT _ingest/ip_location/database/my-database-1
{
  "name": "GeoIP2-Domain",
  "maxmind": {
    "account_id": "1234567"
  }
}

下面显示的 IPinfo 配置需要一个令牌。由于令牌是敏感信息,因此它作为 Elasticsearch 中名为 ingest.ip_location.downloader.ipinfo.token安全设置存储。每个 Elasticsearch 集群当前仅允许一个 IPinfo 令牌。要从 IPinfo 下载,安全设置中必须包含有效的令牌。令牌设置在所有节点重新启动或执行reload_secure_settings请求之前不会生效。

PUT _ingest/ip_location/database/my-database-2
{
  "name": "standard_location",
  "ipinfo": {
  }
}

请求

编辑

PUT /_ingest/ip_location/database/<database>

先决条件

编辑
  • 如果启用了 Elasticsearch 安全功能,则必须具有 manage 集群权限才能使用此 API。

路径参数

编辑
<database>

__ (必填,字符串) 要创建或更新的数据库配置的 ID。

查询参数

编辑
master_timeout
(可选,时间单位) 等待主节点的时间段。如果在超时过期之前主节点不可用,则请求失败并返回错误。默认为 30s。也可以设置为 -1 以指示请求永远不会超时。
timeout
(可选,时间单位) 在更新集群元数据后,等待集群中所有相关节点响应的时间段。如果在超时过期之前未收到响应,则集群元数据更新仍然适用,但响应将指示它未完全确认。默认为 30s。也可以设置为 -1 以指示请求永远不会超时。

请求正文

编辑
name
(必填,字符串) 要下载的 IP 地理位置数据库的提供商分配的名称。
<provider>

(必填,提供商对象及其关联配置) 识别要使用哪个 IP 地理位置提供商下载数据库以及此类下载所需的任何特定于提供商的配置所需的配置。

目前,唯一支持的提供商是 maxmindipinfo。maxmind 提供商要求配置 account_id(字符串)。ipinfo 提供商在请求正文中不需要其他配置。

许可

编辑

从第三方提供商下载数据库是一项商业功能,需要相应的许可证。有关更多信息,请参阅 https://elastic.ac.cn/subscriptions