# 将 Pi-hole 接入 Open Flow

Source: https://openflow.run/zh-cn/integrations/pi_hole/

[全部集成](https://openflow.run/zh-cn/integrations/)

决定是否放行域名前，先查清拦截原因。

*   [40 个工具](https://openflow.run/zh-cn/integrations/pi_hole/#integration-actions)
*   API 密钥
*   安全与身份
*   开发工具

[连接 Pi-hole](https://console.openflow.run/connections/pi_hole)

每月 20,000 次免费应用调用（付费服务另计）

## 可以做什么

在可从公网访问的 Pi-hole 实例上检查 DNS 查询、匹配名单和上游活动。也可以按指定时长调整拦截，并核对变更后的状态。

### 检查域名

读取 DNS 查询，并搜索域名在允许、拦截与 gravity 列表中的记录。

### 查看 DNS 活动

读取概览与上游指标，整理 DNS 活动。

### 设置限时拦截

按明确时长变更拦截模式并查看状态。

## 所有工具

40 个工具

### Get Overview

获取 Pi-hole 活动概览：总查询数和被阻止查询数、被阻止查询百分比、唯一客户端和域名，以及阻止和 gravity 列表状态。

`pi_hole.get_overview`

### Get Dns Blocking Status

获取 Pi-hole DNS 阻止当前是启用、禁用、失败还是未知。

`pi_hole.get_dns_blocking_status`

### Set Dns Blocking

启用或禁用 Pi-hole DNS 阻止，可选择限时，之后自动恢复为相反模式。

`pi_hole.set_dns_blocking`

### Get Queries

查询 Pi-hole DNS 日志，支持可选筛选条件。默认返回最近的查询；每个响应提供下一页的游标。

`pi_hole.get_queries`

### Get Query Types

获取 Pi-hole 已处理的每种 DNS 查询类型的查询数。

`pi_hole.get_query_types`

### Get Top Domains

获取 Pi-hole 处理最多的域名，可选择仅限被阻止的域名。

`pi_hole.get_top_domains`

### Get Top Clients

获取查询 Pi-hole 最多的客户端，可选择仅限被阻止的客户端。

`pi_hole.get_top_clients`

### Get Recent Blocked

获取 Pi-hole 最近阻止的域名。

`pi_hole.get_recent_blocked`

### Get Upstreams

获取 Pi-hole DNS 上游目标的相关指标，包括响应时间。

`pi_hole.get_upstreams`

### Get History

获取 Pi-hole 活动图数据：随时间变化的查询总数，并区分缓存、被阻止和转发。

`pi_hole.get_history`

### Search Domain

搜索域名是否出现在 Pi-hole 的允许列表、阻止列表或 gravity 列表中，以了解其被阻止或允许的原因。

`pi_hole.search_domain`

### Get Config

获取当前 Pi-hole 配置，例如 DNS 设置、隐私级别和 API 设置。

`pi_hole.get_config`

### Update Config

更改部分 Pi-hole 配置，例如 DNS 上游、隐私级别或 API 设置。提供的字段会合并到当前配置中。

`pi_hole.update_config`

### Run Gravity

运行 Pi-hole gravity 更新以刷新阻止列表。实例流式传输 gravity 日志；操作从日志中报告尽力而为的状态以及流的尾部。

`pi_hole.run_gravity`

### Restart Dns

重启 Pi-hole 的 DNS 服务器并重新加载其 DNS 配置。

`pi_hole.restart_dns`

### Flush Dns Logs

清空 Pi-hole DNS 查询日志。

`pi_hole.flush_dns_logs`

### List Groups

列出所有 Pi-hole 组及其成员关系。

`pi_hole.list_groups`

### Create Group

创建一个或多个 Pi-hole 组，可选择带注释和启用状态。

`pi_hole.create_group`

### Update Group

更新一个 Pi-hole 组：重命名，或更改其注释或启用状态。

`pi_hole.update_group`

### Delete Group

按名称删除一个 Pi-hole 组。

`pi_hole.delete_group`

### List Lists

列出 Pi-hole 允许列表和阻止列表（订阅列表）。

`pi_hole.list_lists`

### Add List

向 Pi-hole 添加一个或多个允许列表或阻止列表条目（地址）。

`pi_hole.add_list`

### Update List

更新一个 Pi-hole 列表：更改其注释、启用状态或组成员关系。

`pi_hole.update_list`

### Delete List

按地址删除一个 Pi-hole 允许列表或阻止列表条目。

`pi_hole.delete_list`

### List Domains

列出各个 Pi-hole 域名条目，可选择限制为一种类型或种类。

`pi_hole.list_domains`

### Add Domain

向 Pi-hole 添加一个或多个允许或拒绝的域名条目，可以是精确匹配或正则表达式。

`pi_hole.add_domain`

### Update Domain

更新一个 Pi-hole 域名条目：更改其注释、启用状态或组成员资格。

`pi_hole.update_domain`

### Delete Domain

删除一个 Pi-hole 允许或拒绝的域名条目。

`pi_hole.delete_domain`

### List Clients

列出所有 Pi-hole 客户端及其组成员资格。

`pi_hole.list_clients`

### Create Client

注册一个或多个由 IP 地址、MAC 地址、主机名或接口标识的 Pi-hole 客户端。

`pi_hole.create_client`

### Update Client

更新一个 Pi-hole 客户端的注释或组成员资格。

`pi_hole.update_client`

### Delete Client

按标识符删除一个 Pi-hole 客户端条目。

`pi_hole.delete_client`

### Batch Delete Groups

在一个请求中按名称删除多个 Pi-hole 组。当这些组都不存在时，报告 deleted=false。

`pi_hole.batch_delete_groups`

### Batch Delete Lists

在一个请求中删除多个 Pi-hole 允许列表或阻止列表条目。当这些条目都不存在时，报告 deleted=false。

`pi_hole.batch_delete_lists`

### Batch Delete Domains

在一个请求中删除多个 Pi-hole 域名条目。当这些条目都不存在时，报告 deleted=false。

`pi_hole.batch_delete_domains`

### Batch Delete Clients

在一个请求中删除多个 Pi-hole 客户端条目。当这些客户端都不存在时，报告 deleted=false。

`pi_hole.batch_delete_clients`

### Get Dhcp Leases

获取由 Pi-hole DHCP 服务器分配的当前活动 DHCP 租约。

`pi_hole.get_dhcp_leases`

### Get Network Devices

获取 Pi-hole 在本地网络上看到的设备。

`pi_hole.get_network_devices`

### Export Backup

创建包含所有设置、列表和客户端的完整 Pi-hole teleporter 备份归档（teleporter.zip）。

`pi_hole.export_backup`

### Import Backup

将 Pi-hole teleporter 备份归档（之前导出的 teleporter.zip）恢复到当前实例。

`pi_hole.import_backup`

没有符合搜索条件的工具。

## 将 Pi-hole 接入 Open Flow

[连接 Pi-hole](https://console.openflow.run/connections/pi_hole)

每月 20,000 次免费应用调用（付费服务另计）
