用途:借助 Grafana REST API 查询仪表盘、数据源、告警规则、活动告警和注解,并对 Prometheus 类数据源执行查询,也可创建注解或静默告警。
主要能力:
- 检索仪表盘:GET /api/search?type=dash-db&limit=20,返回 uid、title、url。
- 获取仪表盘详情:GET /api/dashboards/uid/{uid},可读取标题、面板标题与标签。
- 列出数据源:GET /api/datasources,返回 id、name、type、url。
- 列出告警规则:GET /api/v1/provisioning/alert-rules。
- 列出活动告警:GET /api/alertmanager/grafana/api/v2/alerts?active=true。
- 查询 Prometheus:GET /api/datasources/proxy/{datasourceId}/api/v1/query 即时查询;query_range 支持 start、end、step 参数做区间查询。
- 创建注解:POST /api/annotations,传 text、tags、time。
- 静默告警:POST /api/alertmanager/grafana/api/v2/silences,传 matchers、startsAt、endsAt、comment、createdBy。
使用方式:需设置环境变量 GRAFANA_URL(如 https://grafana.example.com)和 GRAFANA_TOKEN(API key 或 service account token)。所有请求在头部携带 Authorization: Bearer $GRAFANA_TOKEN。数据源代理 URL 使用数据源 ID,该 ID 可从列出数据源接口获取。Grafana Cloud 的地址形如 https://your-stack.grafana.net。
适用场景:运维与可观测性排查、查询监控指标、查看告警状态、自动化部署注解与告警静默。
限制与注意:资料提示在静默告警或创建注解前应先确认。令牌与实例权限决定可访问范围。资料未提供其他认证方式、版本兼容性、接口分页限制或收费信息。