community.general.influxdb_query 模块 – 从 InfluxDB 查询数据点

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：community.general.influxdb_query。

概要

  • 从 InfluxDB 查询数据点。

要求

在执行此模块的主机上需要以下要求。

  • influxdb >= 0.9

参数

参数

注释

database_name

字符串 / 必需

数据库的名称。

hostname

字符串

InfluxDB 服务器正在侦听的主机名或 IP 地址。

默认值： "localhost"

password

别名：login_password

字符串

将用于对 InfluxDB 服务器进行身份验证的密码。

默认值： "root"

path

字符串

在 community.general 0.2.0 中添加

InfluxDB 服务器可访问的路径。

仅在使用 python-influxdb >= 5.1.0 时可用。

默认值： ""

port

整数

InfluxDB 服务器正在侦听的端口。

默认值： 8086

proxies

字典

用于连接到 InfluxDB 服务器的 HTTP(S) 代理。

默认值： {}

query

字符串 / 必需

要执行的查询。

retries

整数

客户端在中止之前将尝试的重试次数。

0 表示尝试直到成功。

仅在使用 python-influxdb >= 4.1.0 时可用。

默认值： 3

ssl

布尔值

使用 https 而不是 http 连接到 InfluxDB 服务器。

选项

  • false ← (默认)

  • true

timeout

整数

Requests 将等待客户端建立连接的秒数。

udp_port

整数

用于连接到 InfluxDB 服务器的 UDP 端口。

默认值： 4444

use_udp

布尔值

使用 UDP 连接到 InfluxDB 服务器。

选项

  • false ← (默认)

  • true

username

别名：login_username

字符串

将用于对 InfluxDB 服务器进行身份验证的用户名。

默认值： "root"

validate_certs

布尔值

如果设置为 false，则不会验证 SSL 证书。

只有在使用自签名证书的个人控制站点上才能将其设置为 false。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持：完整

可以在 check_mode 中运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持: 无

当处于差异模式时，将会返回已更改的内容的详细信息（或者在 check_mode 中可能需要更改的内容）。

示例

- name: Query connections
  community.general.influxdb_query:
    hostname: "{{ influxdb_ip_address }}"
    database_name: "{{ influxdb_database_name }}"
    query: "select mean(value) from connections"
  register: connection

- name: Query connections with tags filters
  community.general.influxdb_query:
    hostname: "{{ influxdb_ip_address }}"
    database_name: "{{ influxdb_database_name }}"
    query: "select mean(value) from connections where region='zue01' and host='server01'"
  register: connection

- name: Print results from the query
  ansible.builtin.debug:
    var: connection.query_results

返回值

常见返回值已在此处记录 这里，以下是此模块独有的字段

键

描述

query_results

列表 / 元素=字符串

查询结果

返回: 成功

示例: [{"mean": 1245.5333333333333, "time": "1970-01-01T00:00:00Z"}]

作者

  • René Moser (@resmo)