文档

Grafana 文档

开发者

HTTP API

查询历史记录 HTTP API

企业版开源

查询历史记录 API

此 API 可用于将查询添加到查询历史记录。要求用户已登录，并且在配置文件中启用了查询历史记录功能。

将查询添加到查询历史记录

POST /api/query-history

将查询添加到查询历史记录。

请求示例

POST /api/query-history HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
  "datasourceUid": "PE1C5CBDA0504A6A3",
  "queries": [
    {
        "refId": "A",
        "key": "Q-87fed8e3-62ba-4eb2-8d2a-4129979bb4de-0",
        "scenarioId": "csv_content",
        "datasource": {
            "type": "testdata",
            "uid": "PD8C576611E62080A"
        }
    }
]
}

JSON 请求体 Schema

datasourceUid – 数据源 UID。
queries – 查询或多个查询的 JSON。

响应示例

HTTP/1.1 200
Content-Type: application/json
{
  "result": {
    "uid": "Ahg678z",
    "datasourceUid": "PE1C5CBDA0504A6A3",
    "createdBy": 1,
    "createdAt": 1643630762,
    "starred": false,
    "comment": "",
    "queries": [
      {
        "refId": "A",
        "key": "Q-87fed8e3-62ba-4eb2-8d2a-4129979bb4de-0",
        "scenarioId": "csv_content",
        "datasource": {
            "type": "testdata",
            "uid": "PD8C576611E62080A"
        }
      }
    ]
  }
}

状态码

200 – 成功
400 - 错误（无效的 JSON，缺少或无效的字段）
401 – 未授权
500 – 内部错误

查询历史记录搜索

GET /api/query-history

返回查询历史记录中符合搜索条件的查询列表。查询历史记录搜索支持分页。使用 limit 参数控制返回的最大查询数；默认限制为 100。您也可以使用 page 查询参数获取除第一页以外的任何页面中的查询。

查询参数

datasourceUid - 过滤选定数据源的查询历史记录。要对多个数据源执行“AND”过滤，请使用以下格式指定数据源参数：datasourceUid=uid1&datasourceUid=uid2。
searchString – 根据内容过滤查询历史记录。
sort - 指定排序顺序。排序可以是 time-asc（时间升序）或 time-desc（时间降序）。默认值为 time-desc。
onlyStarred - 搜索已加星标的查询。默认为 false。
page - 搜索支持分页。指定要返回的页码。使用 limit 参数指定每页的查询数量。
limit - 限制每页返回的查询历史记录项数量。默认每页 100 个查询。
from/to - 指定查询历史记录搜索的时间范围。时间可以是毫秒为单位的 epoch 时间戳，也可以是使用 Grafana 时间单位的相对时间。例如，now-5m。

查询历史记录搜索请求示例:

GET /api/query-history?datasourceUid="PE1C5CBDA0504A6A3"&datasourceUid="FG1C1CBDA0504A6EL"&searchString="ALERTS"&sort="time-asc" HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

查询历史记录搜索响应示例:

HTTP/1.1 200
Content-Type: application/json
{
  "result": {
    "totalCount": 150,
    "page": 1,
    "perPage": 100
    "queryHistory":[{
    "uid": "Ahg678z",
    "datasourceUid": "PE1C5CBDA0504A6A3",
    "createdBy": 1,
    "createdAt": 1643630762,
    "starred": false,
    "comment": "",
    "queries": [
      {
        "refId": "A",
        "key": "Q-87fed8e3-62ba-4eb2-8d2a-4129979bb4de-0",
        "scenarioId": "csv_content",
        "datasource": {
            "type": "testdata",
            "uid": "PE1C5CBDA0504A6A3"
        }
      }
    ]
  }]
}

状态码

200 – 成功
401 – 未授权
500 – 内部错误

按 UID 从查询历史记录中删除查询

DELETE /api/query-history/:uid

删除查询历史记录中与指定 UID 匹配的查询。要求用户已登录，并且在配置文件中启用了查询历史记录功能。

请求示例:

DELETE /api/query-history/P8zM2I1nz HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

响应示例:

HTTP/1.1 200
Content-Type: application/json

{
    "message": "Query deleted",
    "id": 28
}

状态码

200 – 成功
401 – 未授权
500 – 内部错误

按 UID 更新查询历史记录中查询的评论

PATCH /api/query-history/:uid

更新查询历史记录中具有特定 UID 的查询的评论。

查询参数

comment – 将添加到指定查询的新评论。

请求示例:

PATCH /api/query-history/P8zM2I1nz HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
  "comment": "Debugging query",
}

响应示例:

HTTP/1.1 200
Content-Type: application/json
{
  "result": {
    "uid": "P8zM2I1nz",
    "datasourceUid": "PE1C5CBDA0504A6A3",
    "createdBy": 1,
    "createdAt": 1643630762,
    "starred": false,
    "comment": "Debugging query",
    "queries": [
      {
        "refId": "A",
        "key": "Q-87fed8e3-62ba-4eb2-8d2a-4129979bb4de-0",
        "scenarioId": "csv_content",
        "datasource": {
            "type": "testdata",
            "uid": "PD8C576611E62080A"
        }
      }
    ]
  }
}

状态码

200 – 成功
400 - 错误（无效的 JSON，缺少或无效的字段）
401 – 未授权
500 – 内部错误

在查询历史记录中为查询加星标

POST /api/query-history/star/:uid

在查询历史记录中为查询加星标。

请求示例

POST /api/query-history/star/P8zM2I1nz HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

响应示例

HTTP/1.1 200
Content-Type: application/json
{
  "result": {
    "uid": "P8zM2I1nz",
    "datasourceUid": "PE1C5CBDA0504A6A3",
    "createdBy": 1,
    "createdAt": 1643630762,
    "starred": false,
    "comment": "Debugging query",
    "queries": [
      {
        "refId": "A",
        "key": "Q-87fed8e3-62ba-4eb2-8d2a-4129979bb4de-0",
        "scenarioId": "csv_content",
        "datasource": {
            "type": "testdata",
            "uid": "PD8C576611E62080A"
        }
      }
    ]
  }
}

状态码

200 – 成功
401 – 未授权
500 – 内部错误

在查询历史记录中取消查询的星标

DELETE /api/query-history/star/:uid

从查询历史记录中的查询中移除星标。

请求示例

DELETE /api/query-history/star/P8zM2I1nz  HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

响应示例

HTTP/1.1 200
Content-Type: application/json
{
  "result": {
    "uid": "P8zM2I1nz",
    "datasourceUid": "PE1C5CBDA0504A6A3",
    "createdBy": 1,
    "createdAt": 1643630762,
    "starred": false,
    "comment": "Debugging query",
    "queries": [
      {
        "refId": "A",
        "key": "Q-87fed8e3-62ba-4eb2-8d2a-4129979bb4de-0",
        "scenarioId": "csv_content",
        "datasource": {
            "type": "testdata",
            "uid": "PD8C576611E62080A"
        }
      }
    ]
  }
}

状态码