API 参考

class grafana_dashboards.grafana.Grafana(url, key=None)

创建 Grafana 实例对象

参数：

• url (str) – Grafana 服务器的 URL

• key (str) – 用于身份验证的 API 令牌

class grafana_dashboards.grafana.datasource.Datasource(url, session)

create(name, data)

创建一个新的数据源

参数：

• name (str) – 数据源的 URL 友好的标题

• data (dict) – 数据源模型

引发:

Exception – 如果数据源已存在

delete(datasource_id)

删除一个数据源

参数：

datasource_id (int) – 数据源的 ID 编号

引发:

Exception – 如果数据源删除失败

get(datasource_id)

获取一个数据源

参数：

datasource_id (int) – 数据源的 ID 编号

返回类型:

dict 或 None

get_all()

列出所有数据源

返回类型:

dict

is_datasource(name)

检查数据源是否存在

参数：

name (str) – 数据源的 URL 友好的标题

返回值:

如果数据源存在，则返回 ID 编号。

返回类型:

int

update(datasource_id, data)

更新现有的数据源

参数：

• datasource_id (int) – 数据源的 URL 友好的标题

• data (dict) – 数据源模型

• overwrite (bool) – 使用新版本覆盖现有仪表盘，或使用相同的仪表盘标题

引发:

Exception – 如果数据源已存在

class grafana_dashboards.grafana.dashboard.Dashboard(url, session)

create(name, data, overwrite=False, folder_id=0)

创建一个新的仪表盘

参数：

• name (str) – 数据源的 URL 友好的标题

• data (dict) – 仪表盘模型

• overwrite (bool) – 使用新版本覆盖现有仪表盘，或使用相同的仪表盘标题

• folder_id (int) – 保存仪表盘的文件夹的 ID。

引发:

Exception – 如果仪表盘已存在

dashboard_uid(name)

delete(name)

删除一个仪表盘

参数：

name (str) – 数据源的 URL 友好的标题

引发:

Exception – 如果仪表盘删除失败

get(name)

获取一个仪表盘

参数：

name (str) – 数据源的 URL 友好的标题

返回类型:

dict 或 None

is_dashboard(name)

检查仪表盘是否存在

参数：

name (str) – 数据源的 URL 友好的标题

返回值:

如果仪表盘存在，则返回 True

返回类型:

bool