Grafana

与 Grafana 仪表盘、告警和注解交互

配置

列出仪表盘

操作
列出仪表盘
Grafana 地址*
https://your-grafana.com
服务账号令牌*
••••••••
组织 ID
可选,用于多组织实例
搜索查询
按标题筛选仪表盘
按标签筛选
tag1, tag2(逗号分隔)
列出仪表板 (grafana_list_dashboards)

搜索并列出所有仪表板

输入
参数类型必填说明
apiKeystring是Grafana 服务账户令牌
baseUrlstring是Grafana 实例 URL(例如:https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
querystring否按标题筛选仪表板的搜索查询
tagstring否按标签筛选(多个标签用逗号分隔)
folderIdsstring否按文件夹 ID 筛选(逗号分隔)
starredboolean否仅返回已加星标的仪表板
limitnumber否返回的仪表板最大数量
输出
参数类型说明
dashboardsarray仪表板搜索结果列表

获取仪表板

操作
获取仪表板
Grafana URL*
https://your-grafana.com
服务账户令牌*
••••••••
组织 ID
可选 - 用于多组织实例
仪表板 UID*
输入仪表板 UID
获取仪表盘 (grafana_get_dashboard)

通过 UID 获取仪表盘

输入
参数类型必填说明
apiKeystring是Grafana 服务账号令牌
baseUrlstring是Grafana 实例 URL(例如 https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
dashboardUidstring是要获取的仪表盘 UID
输出
参数类型说明
dashboardjson完整的仪表盘 JSON 对象
metajson仪表盘元数据(版本、权限等)

创建仪表盘

操作
创建仪表盘
Grafana URL*
https://your-grafana.com
服务账号令牌*
••••••••
组织 ID
可选,用于多组织实例
仪表盘标题*
输入仪表盘标题
文件夹 UID
可选,创建仪表盘所用的文件夹
标签
tag1, tag2(逗号分隔)
面板(JSON)
面板配置的 JSON 数组
提交说明
可选的版本说明
创建仪表盘 (grafana_create_dashboard)

创建新仪表盘

输入
参数类型必填说明
apiKeystring是Grafana 服务账户令牌
baseUrlstring是Grafana 实例 URL(例如 https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
titlestring是新仪表盘的标题
folderUidstring否用于创建该仪表盘的文件夹 UID
tagsstring否逗号分隔的标签列表
timezonestring否仪表盘时区(例如 browser、utc)
refreshstring否自动刷新间隔(例如 5s、1m、5m)
panelsstring否面板配置的 JSON 数组
overwriteboolean否覆盖同标题的现有仪表盘
messagestring否仪表盘版本的提交说明
输出
参数类型说明
idnumber已创建仪表盘的数字 ID
uidstring已创建仪表盘的 UID
urlstring仪表盘的 URL 路径
statusstring操作状态(success)
versionnumber仪表盘的版本号
slugstring仪表盘的 URL 友好 slug

更新仪表盘

操作
更新仪表盘
Grafana 网址*
https://your-grafana.com
服务账户令牌*
••••••••
组织 ID
可选,用于多组织实例
仪表盘 UID*
输入仪表盘 UID
文件夹 UID
可选,创建仪表盘所在的文件夹
标签
tag1, tag2(逗号分隔)
面板(JSON)
面板配置的 JSON 数组
提交说明
可选的版本说明
更新仪表板(grafana_update_dashboard)

更新现有仪表板。获取当前仪表板并合并你的更改。

输入
参数类型必填说明
apiKeystring是Grafana 服务账号令牌
baseUrlstring是Grafana 实例 URL (例如:https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
dashboardUidstring是要更新的仪表板 UID
titlestring否仪表板的新标题
folderUidstring否要将仪表板移动到的新文件夹 UID
tagsstring否逗号分隔的新标签列表
timezonestring否仪表板时区 (例如:browser、utc)
refreshstring否自动刷新间隔 (例如:5s、1m、5m)
panelsstring否面板配置的 JSON 数组
overwriteboolean否即使存在版本冲突也覆盖
messagestring否此版本的提交说明
输出
参数类型说明
idnumber已更新仪表板的数字 ID
uidstring已更新仪表板的 UID
urlstring仪表板的 URL 路径
statusstring操作状态 (success)
versionnumber仪表板的新版本号
slugstring仪表板的 URL 友好 slug

删除仪表盘

操作
删除仪表盘
Grafana 地址*
https://your-grafana.com
服务账户令牌*
••••••••
组织 ID
可选,用于多组织实例
仪表盘 UID*
输入仪表盘 UID
删除仪表盘 (grafana_delete_dashboard)

按 UID 删除仪表盘

输入
ParameterTypeRequiredDescription
apiKeystring是Grafana 服务账户令牌
baseUrlstring是Grafana 实例 URL(例如:https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
dashboardUidstring是要删除的仪表盘 UID
输出
ParameterTypeDescription
titlestring已删除仪表盘的标题
messagestring确认消息
idnumber已删除仪表盘的 ID

列出告警规则

操作
列出告警规则
Grafana URL*
https://your-grafana.com
服务账户令牌*
••••••••
组织 ID
可选,用于多组织实例
列出告警规则(grafana_list_alert_rules)

列出 Grafana 实例中的所有告警规则

输入
参数类型必填说明
apiKeystring是Grafana 服务账户令牌
baseUrlstring是Grafana 实例 URL(例如:https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
输出
参数类型说明
rulesarray告警规则列表

获取告警规则

操作
获取告警规则
Grafana URL*
https://your-grafana.com
服务账户令牌*
••••••••
组织 ID
可选,用于多组织实例
告警规则 UID*
输入告警规则 UID
获取告警规则 (grafana_get_alert_rule)

根据 UID 获取特定告警规则

输入
参数类型必填说明
apiKeystring是Grafana 服务账户令牌
baseUrlstring是Grafana 实例 URL (例如 https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
alertRuleUidstring是要获取的告警规则 UID
输出
参数类型说明
uidstring告警规则 UID
titlestring告警规则标题
conditionstring告警条件
datajson告警规则查询数据
folderUIDstring父文件夹 UID
ruleGroupstring规则组名称
noDataStatestring无数据返回时的状态
execErrStatestring执行出错时的状态
annotationsjson告警注释
labelsjson告警标签

创建告警规则

操作
创建告警规则
Grafana URL*
https://your-grafana.com
服务账户令牌*
••••••••
组织 ID
可选,用于多组织实例
文件夹 UID
可选,创建仪表盘所在的文件夹
告警标题
输入告警规则名称
文件夹 UID
告警规则所属文件夹的 UID
规则组
输入规则组名称
条件
条件 refId(例如 A)
查询数据 (JSON)
查询/表达式数据对象的 JSON 数组
持续时长
5m(例如 5m、1h)
无数据状态
无数据
错误状态
告警
创建告警规则(grafana_create_alert_rule)

创建新的告警规则

输入
参数类型必填说明
apiKeystring是Grafana 服务账号令牌
baseUrlstring是Grafana 实例 URL(例如:https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
titlestring是告警规则的标题
folderUidstring是用于创建告警的文件夹 UID
ruleGroupstring是规则组名称
conditionstring是用作告警条件的查询或表达式的 refId
datastring是查询/表达式数据对象的 JSON 数组
forDurationstring否触发前等待的时长(例如:5m、1h)
noDataStatestring否无数据返回时的状态(NoData、Alerting、OK)
execErrStatestring否执行出错时的状态(Alerting、OK)
annotationsstring否注解的 JSON 对象
labelsstring否标签的 JSON 对象
输出
参数类型说明
uidstring已创建告警规则的 UID
titlestring告警规则标题
folderUIDstring父文件夹 UID
ruleGroupstring规则组名称

更新告警规则

操作
更新告警规则
Grafana 地址*
https://your-grafana.com
服务账号令牌*
••••••••
组织 ID
可选,用于多组织实例
告警规则 UID*
输入告警规则 UID
告警标题
输入告警规则名称
文件夹 UID
告警规则的文件夹 UID
规则组
输入规则组名称
条件
条件 refId(例如 A)
查询数据(JSON)
查询/表达式数据对象的 JSON 数组
持续时长
5m(例如 5m、1h)
无数据状态
无数据
错误状态
告警
更新告警规则 (grafana_update_alert_rule)

更新现有告警规则。获取当前规则并合并你的更改。

输入
参数类型必填说明
apiKeystring是Grafana 服务账号令牌
baseUrlstring是Grafana 实例 URL(例如:https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
alertRuleUidstring是要更新的告警规则 UID
titlestring否告警规则的新标题
folderUidstring否要将告警移至的新文件夹 UID
ruleGroupstring否新规则组名称
conditionstring否新条件 refId
datastring否查询/表达式数据对象的新 JSON 数组
forDurationstring否触发前等待的时长(例如:5m、1h)
noDataStatestring否无数据返回时的状态(NoData、Alerting、OK)
execErrStatestring否执行出错时的状态(Alerting、OK)
annotationsstring否注解的 JSON 对象
labelsstring否标签的 JSON 对象
输出
参数类型说明
uidstring已更新告警规则的 UID
titlestring告警规则标题
folderUIDstring父文件夹 UID
ruleGroupstring规则组名称

删除告警规则

操作
删除告警规则
Grafana URL*
https://your-grafana.com
服务账号令牌*
••••••••
组织 ID
可选 - 用于多组织实例
告警规则 UID*
输入告警规则 UID
删除告警规则 (grafana_delete_alert_rule)

按 UID 删除告警规则

输入
参数类型必填说明
apiKeystring是Grafana 服务账户令牌
baseUrlstring是Grafana 实例 URL(例如 https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
alertRuleUidstring是要删除的告警规则 UID
输出
参数类型说明
messagestring确认消息

列出联系点

操作
列出联系点
Grafana URL*
https://your-grafana.com
服务账户令牌*
••••••••
组织 ID
可选,用于多组织实例
列出联系点 (grafana_list_contact_points)

列出所有告警通知联系点

输入
参数类型必填说明
apiKeystring是Grafana 服务账号令牌
baseUrlstring是Grafana 实例 URL (例如:https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
输出
参数类型说明
contactPointsarray联系点列表

创建注释

操作
创建注释
Grafana URL*
https://your-grafana.com
服务账号令牌*
••••••••
组织 ID
可选,用于多组织实例
注释文本*
输入注释文本...
标签
tag1, tag2(逗号分隔)
仪表盘 UID*
输入仪表盘 UID
面板 ID
可选,关联到指定面板
时间(epoch 毫秒)
可选,默认为当前时间
结束时间(epoch 毫秒)
可选,用于范围注释
创建注释 (grafana_create_annotation)

在仪表板上创建注释,或创建全局注释

输入
参数类型必填说明
apiKeystring是Grafana 服务账号令牌
baseUrlstring是Grafana 实例 URL(例如 https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
textstring是注释的文本内容
tagsstring否逗号分隔的标签列表
dashboardUidstring是要添加注释的仪表板 UID
panelIdnumber否要添加注释的面板 ID
timenumber否开始时间(纪元毫秒,默认为当前时间)
timeEndnumber否结束时间(纪元毫秒,用于范围注释)
输出
参数类型说明
idnumber已创建注释的 ID
messagestring确认消息

列出注释

操作
列出注释
Grafana URL*
https://your-grafana.com
服务账号令牌*
••••••••
组织 ID
可选 - 用于多组织实例
标签
tag1, tag2(逗号分隔)
仪表板 UID*
输入仪表板 UID
面板 ID
可选 - 附加到特定面板
起始时间(纪元毫秒)
按起始时间筛选
结束时间(纪元毫秒)
按结束时间筛选
列出注解 (grafana_list_annotations)

按时间范围、仪表盘或标签查询注解

输入
参数类型必填说明
apiKeystring是Grafana 服务账号令牌
baseUrlstring是Grafana 实例 URL(例如:https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
fromnumber否起始时间(epoch 毫秒)
tonumber否结束时间(epoch 毫秒)
dashboardUidstring是要查询注解的仪表盘 UID
panelIdnumber否按面板 ID 筛选
tagsstring否用于筛选的标签列表(逗号分隔)
typestring否按类型筛选(alert 或 annotation)
limitnumber否返回的注解最大数量
输出
参数类型说明
annotationsarray注解列表

更新注解

操作
更新注解
Grafana URL*
https://your-grafana.com
服务账号令牌*
••••••••
组织 ID
可选,用于多组织实例
注解文本*
输入注解文本...
标签
tag1, tag2(逗号分隔)
时间(epoch 毫秒)
可选,默认为当前时间
结束时间(epoch 毫秒)
可选,用于范围注解
注解 ID*
输入注解 ID
更新注释 (grafana_update_annotation)

更新现有注释

输入
参数类型必填说明
apiKeystring是Grafana 服务账号令牌
baseUrlstring是Grafana 实例 URL(例如:https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
annotationIdnumber是要更新的注释 ID
textstring是注释的新文本内容
tagsstring否逗号分隔的新标签列表
timenumber否新的开始时间(epoch 毫秒)
timeEndnumber否新的结束时间(epoch 毫秒)
输出
参数类型说明
idnumber已更新注释的 ID
messagestring确认消息

删除注释

操作
删除注释
Grafana URL*
https://your-grafana.com
服务账号令牌*
••••••••
组织 ID
可选 - 用于多组织实例
注释 ID*
输入注释 ID
删除注释 (grafana_delete_annotation)

根据 ID 删除注释

输入
参数类型必填说明
apiKeystring是Grafana 服务账号令牌
baseUrlstring是Grafana 实例 URL(例如:https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
annotationIdnumber是要删除的注释 ID
输出
参数类型说明
messagestring确认消息

列出数据源

操作
列出数据源
Grafana URL*
https://your-grafana.com
服务账号令牌*
••••••••
组织 ID
可选 - 用于多组织实例
列出数据源 (grafana_list_data_sources)

列出 Grafana 中已配置的所有数据源

输入
参数类型必填说明
apiKeystring是Grafana 服务账号令牌
baseUrlstring是Grafana 实例 URL(例如 https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
输出
参数类型说明
dataSourcesarray数据源列表

获取数据源

操作
获取数据源
Grafana URL*
https://your-grafana.com
服务账号令牌*
••••••••
组织 ID
可选,用于多组织实例
数据源 ID*
输入数据源 ID 或 UID
获取数据源 (grafana_get_data_source)

按 ID 或 UID 获取数据源

输入
参数类型必填说明
apiKeystring是Grafana 服务账号令牌
baseUrlstring是Grafana 实例 URL (例如 https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
dataSourceIdstring是要获取的数据源 ID 或 UID
输出
参数类型说明
idnumber数据源 ID
uidstring数据源 UID
namestring数据源名称
typestring数据源类型
urlstring数据源连接 URL
databasestring数据库名称 (如适用)
isDefaultboolean是否为默认数据源
jsonDatajson其他数据源配置

列出文件夹

操作
列出文件夹
Grafana URL*
https://your-grafana.com
服务账号令牌*
••••••••
组织 ID
可选 - 用于多组织实例
列出文件夹 (grafana_list_folders)

列出 Grafana 中的所有文件夹

输入
参数类型必填说明
apiKeystring是Grafana 服务账号令牌
baseUrlstring是Grafana 实例 URL (例如:https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
limitnumber否返回的文件夹数量上限
pagenumber否分页页码
输出
参数类型说明
foldersarray文件夹列表

创建文件夹

操作
创建文件夹
Grafana URL*
https://your-grafana.com
服务账号令牌*
••••••••
组织 ID
可选,用于多组织实例
文件夹标题*
输入文件夹标题
文件夹 UID
可选,未提供时自动生成
创建文件夹 (grafana_create_folder)

在 Grafana 中创建新文件夹

输入
参数类型必填说明
apiKeystring是Grafana 服务账户令牌
baseUrlstring是Grafana 实例 URL(例如 https://your-grafana.com)
organizationIdstring否多组织 Grafana 实例的组织 ID
titlestring是新文件夹的标题
uidstring否文件夹的可选 UID(未提供时自动生成)
输出
参数类型说明
idnumber已创建文件夹的数字 ID
uidstring已创建文件夹的 UID
titlestring已创建文件夹的标题
urlstring文件夹的 URL 路径
hasAclboolean该文件夹是否具有自定义 ACL 权限
canSaveboolean当前用户是否可以保存该文件夹
canEditboolean当前用户是否可以编辑该文件夹
canAdminboolean当前用户是否对该文件夹拥有管理员权限
canDeleteboolean当前用户是否可以删除该文件夹
createdBystring创建该文件夹的用户名
createdstring文件夹的创建时间戳
updatedBystring最后更新该文件夹的用户名
updatedstring文件夹的最后更新时间戳
versionnumber文件夹的版本号

使用说明

将 Grafana 集成到工作流中。管理仪表盘、告警、注释、数据源和文件夹,并监控健康状态。

说明

  • 类别:tools
  • 类型:grafana