文档

Grafana 文档

开发者

HTTP API

查询和资源缓存 HTTP API

Enterprise 开源

查询和资源缓存 API

注意
如果您运行的是 Grafana Enterprise，对于某些端点，您需要拥有特定的权限。有关更多信息，请参阅基于角色的访问控制权限。

为数据源启用缓存

POST /api/datasources/:dataSourceUID/cache/enable

所需权限

有关说明，请参阅引言中的注意事项。

操作	范围
datasources.caching:write	datasources:*

示例

请求示例:

POST /api/datasources/jZrmlLCGka/cache/enable HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

响应示例:

HTTP/1.1 200
Content-Type: application/json

{
   "message": "Data source cache enabled",
   "dataSourceID": 1,
   "dataSourceUID": "jZrmlLCGka",
   "enabled": true,
   "ttlQueriesMs": 300000,
   "ttlResourcesMs": 300000,
   "useDefaultTTL": true,
   "defaultTTLMs": 300000,
   "created": "2023-04-21T11:49:22-04:00",
   "updated": "2023-04-24T16:30:29-04:00"
}

状态码

代码	说明
200	已成功为数据源启用缓存
500	发生意外错误。有关更多详细信息，请参阅正文和/或服务器日志。

为数据源禁用缓存

POST /api/datasources/:dataSourceUID/cache/disable

所需权限

有关说明，请参阅引言中的注意事项。

操作	范围
datasources.caching:write	datasources:*

示例

请求示例:

POST /api/datasources/jZrmlLCGka/cache/disable HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

响应示例:

HTTP/1.1 200
Content-Type: application/json

{
   "message": "Data source cache disabled",
   "dataSourceID": 1,
   "dataSourceUID": "jZrmlLCGka",
   "enabled": false,
   "ttlQueriesMs": 300000,
   "ttlResourcesMs": 300000,
   "useDefaultTTL": true,
   "defaultTTLMs": 0,
   "created": "2023-04-21T11:49:22-04:00",
   "updated": "2023-04-24T16:30:31-04:00"
}

状态码

代码	说明
200	已成功为数据源启用缓存
500	发生意外错误。有关更多详细信息，请参阅正文和/或服务器日志。

清理所有数据源的缓存

POST /api/datasources/:dataSourceUID/cache/clean

将清理所有启用缓存的数据源的缓存数据。指定的 dataSourceUID 仅用于返回该数据源的配置。

所需权限

有关说明，请参阅引言中的注意事项。

操作	范围
datasources.caching:write	datasources:*

示例

请求示例:

POST /api/datasources/jZrmlLCGka/cache/clean HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

响应示例:

HTTP/1.1 200
Content-Type: application/json

{
   "message": "Data source cache cleaned",
   "dataSourceID": 1,
   "dataSourceUID": "jZrmlLCGka",
   "enabled": false,
   "ttlQueriesMs": 300000,
   "ttlResourcesMs": 300000,
   "useDefaultTTL": true,
   "defaultTTLMs": 0,
   "created": "2023-04-21T11:49:22-04:00",
   "updated": "2023-04-24T16:30:31-04:00"
}

状态码

代码	说明
200	已成功为数据源启用缓存
500	发生意外错误。有关更多详细信息，请参阅正文和/或服务器日志。

更新数据源的缓存配置

POST /api/datasources/:dataSourceUID/cache

所需权限

有关说明，请参阅引言中的注意事项。

操作	范围
datasources.caching:write	datasources:*

示例

请求示例:

POST /api/datasources/jZrmlLCGka/cache HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
   "dataSourceID": 1,
   "dataSourceUID": "jZrmlLCGka",
   "enabled": true,
   "useDefaultTTL": false,
   "ttlQueriesMs": 60000,
   "ttlResourcesMs": 300000,
}

JSON 请求体 Schema

字段名称	数据类型	说明
dataSourceID	number	要配置的数据源 ID。
dataSourceUID	string	要配置的数据源 UID。
enabled	boolean	是否为此数据源启用缓存。
useDefaultTTL	boolean	是否应使用配置的默认 TTL（存活时间）进行查询和资源缓存，而不是使用用户指定的值。
ttlQueriesMs	number	用于查询缓存的 TTL（毫秒）。
ttlResourcesMs	number	用于资源缓存的 TTL（毫秒）。

响应示例:

HTTP/1.1 200
Content-Type: application/json

{
   "message": "Data source cache settings updated",
   "dataSourceID": 1,
   "dataSourceUID": "jZrmlLCGka",
   "enabled": true,
   "useDefaultTTL": false,
   "ttlQueriesMs": 60000,
   "ttlResourcesMs": 300000,
   "defaultTTLMs": 300000,
   "created": "2023-04-21T11:49:22-04:00",
   "updated": "2023-04-24T17:03:40-04:00"
}

状态码

代码	说明
200	已成功为数据源启用缓存
400	请求错误（无效 json、缺失或无效字段等）
500	发生意外错误。有关更多详细信息，请参阅正文和/或服务器日志。

获取数据源的缓存配置

GET /api/datasources/:dataSourceUID/cache

所需权限

有关说明，请参阅引言中的注意事项。

操作	范围
datasources.caching:read	datasources:*

示例

请求示例:

GET /api/datasources/jZrmlLCGka/cache HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

响应示例:

HTTP/1.1 200
Content-Type: application/json

{
   "message": "Data source cache settings loaded",
   "dataSourceID": 1,
   "dataSourceUID": "jZrmlLCGka",
   "enabled": true,
   "useDefaultTTL": false,
   "ttlQueriesMs": 60000,
   "ttlResourcesMs": 300000,
   "defaultTTLMs": 300000,
   "created": "2023-04-21T11:49:22-04:00",
   "updated": "2023-04-24T17:03:40-04:00"
}