菜单

数据源 HTTP API

企业版开源版

数据源 API

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

获取所有数据源

GET /api/datasources

警告
此 API 目前不处理分页。返回的数据源默认最大数量为 5000。您可以在 default.ini 文件中更改此值。

所需权限

请参阅简介中的说明。

操作	范围
datasources:read	datasources:*

示例

示例请求:

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

示例响应:

HTTP/1.1 200
Content-Type: application/json

[
   {
     "id": 1,
     "orgId": 1,
     "uid": "H8joYFVGz"
     "name": "datasource_elastic",
     "type": "elasticsearch",
     "typeLogoUrl": "public/app/plugins/datasource/elasticsearch/img/elasticsearch.svg",
     "access": "proxy",
     "url": "http://mydatasource.com",
     "password": "",
     "user": "",
     "database": "grafana-dash",
     "basicAuth": false,
     "isDefault": false,
     "jsonData": {
         "logLevelField": "",
         "logMessageField": "",
         "maxConcurrentShardRequests": 256,
         "timeField": "@timestamp"
     },
     "readOnly": false
   }
]

通过 ID 获取单个数据源

GET /api/datasources/:datasourceId

警告
此 API 自 Grafana v9.0.0 起已弃用，将在未来版本中移除。请参考通过 UID 获取单个数据源的 API 或通过名称获取单个数据源的 API。

所需权限

请参阅简介中的说明。

操作	范围
datasources:read	datasources:* datasources:id:* datasources:id:1 (单个数据源)

示例

示例请求:

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

示例响应:

HTTP/1.1 200
Content-Type: application/json

{
  "id": 1,
  "uid": "kLtEtcRGk",
  "orgId": 1,
  "name": "test_datasource",
  "type": "graphite",
  "typeLogoUrl": "",
  "access": "proxy",
  "url": "http://mydatasource.com",
  "password": "",
  "user": "",
  "database": "",
  "basicAuth": false,
  "basicAuthUser": "",
  "basicAuthPassword": "",
  "withCredentials": false,
  "isDefault": false,
  "jsonData": {
    "graphiteType": "default",
    "graphiteVersion": "1.1"
  },
  "secureJsonFields": {},
  "version": 1,
  "readOnly": false
}

通过 UID 获取单个数据源

GET /api/datasources/uid/:uid

所需权限

请参阅简介中的说明。

操作	范围
datasources:read	datasources:* datasources:uid:* datasources:uid:kLtEtcRGk (单个数据源)

示例

示例请求

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

示例响应:

HTTP/1.1 200
Content-Type: application/json

{
  "id": 1,
  "uid": "kLtEtcRGk",
  "orgId": 1,
  "name": "test_datasource",
  "type": "graphite",
  "typeLogoUrl": "",
  "access": "proxy",
  "url": "http://mydatasource.com",
  "password": "",
  "user": "",
  "database": "",
  "basicAuth": false,
  "basicAuthUser": "",
  "basicAuthPassword": "",
  "withCredentials": false,
  "isDefault": false,
  "jsonData": {
    "graphiteType": "default",
    "graphiteVersion": "1.1"
  },
  "secureJsonFields": {},
  "version": 1,
  "readOnly": false
}

通过名称获取单个数据源

GET /api/datasources/name/:name

所需权限

请参阅简介中的说明。

操作	范围
datasources:read	datasources:* datasources:name:* datasources:name:test_datasource (单个数据源)

示例

示例请求:

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

示例响应:

HTTP/1.1 200
Content-Type: application/json

{
  "id": 1,
  "uid": "kLtEtcRGk",
  "orgId": 1,
  "name": "test_datasource",
  "type": "graphite",
  "typeLogoUrl": "",
  "access": "proxy",
  "url": "http://mydatasource.com",
  "password": "",
  "user": "",
  "database": "",
  "basicAuth": false,
  "basicAuthUser": "",
  "basicAuthPassword": "",
  "withCredentials": false,
  "isDefault": false,
  "jsonData": {
    "graphiteType": "default",
    "graphiteVersion": "1.1"
  },
  "secureJsonFields": {},
  "version": 1,
  "readOnly": false
}

通过名称获取数据源 ID

GET /api/datasources/id/:name

所需权限

请参阅简介中的说明。

操作	范围
datasources.id:read	datasources:* datasources:name:* datasources:name:test_datasource (单个数据源)

示例

示例请求:

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

示例响应:

HTTP/1.1 200
Content-Type: application/json

{
  "id":1
}

创建数据源

POST /api/datasources

所需权限

请参阅简介中的说明。

操作	范围
datasources:create	n/a

示例

示例 Graphite 请求:

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

{
  "name":"test_datasource",
  "type":"graphite",
  "url":"http://mydatasource.com",
  "access":"proxy",
  "basicAuth":false
}

示例 Graphite 响应:

HTTP/1.1 200
Content-Type: application/json

{
  "datasource": {
    "id": 1,
    "orgId": 1,
    "name": "test_datasource",
    "type": "graphite",
    "typeLogoUrl": "",
    "access": "proxy",
    "url": "http://mydatasource.com",
    "password": "",
    "user": "",
    "database": "",
    "basicAuth": false,
    "basicAuthUser": "",
    "basicAuthPassword": "",
    "withCredentials": false,
    "isDefault": false,
    "jsonData": {},
    "secureJsonFields": {},
    "version": 1,
    "readOnly": false
  },
  "id": 1,
  "message": "Datasource added",
  "name": "test_datasource"
}

注意
通过在 secureJsonData 下定义 password 和 basicAuthPassword，Grafana 会将它们安全地加密为数据库中的加密 blob。然后，响应会在 secureJsonFields 下列出加密字段。

启用基本身份验证的示例 Graphite 请求:

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

{
  "name": "test_datasource",
  "type": "graphite",
  "url": "http://mydatasource.com",
  "access": "proxy",
  "basicAuth": true,
  "basicAuthUser": "basicuser",
  "secureJsonData": {
    "basicAuthPassword": "basicpassword"
  }
}

启用基本身份验证的示例响应:

HTTP/1.1 200
Content-Type: application/json

{
  "datasource": {
    "id": 1,
    "orgId": 1,
    "name": "test_datasource",
    "type": "graphite",
    "typeLogoUrl": "",
    "access": "proxy",
    "url": "http://mydatasource.com",
    "password": "",
    "user": "",
    "database": "",
    "basicAuth": true,
    "basicAuthUser": "basicuser",
    "basicAuthPassword": "",
    "withCredentials": false,
    "isDefault": false,
    "jsonData": {},
    "secureJsonFields": {
      "basicAuthPassword": true
    },
    "version": 1,
    "readOnly": false
  },
  "id": 102,
  "message": "Datasource added",
  "name": "test_datasource"
}

示例 CloudWatch 请求:

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

{
  "name": "test_datasource",
  "type": "cloudwatch",
  "url": "http://monitoring.us-west-1.amazonaws.com",
  "access": "proxy",
  "jsonData": {
    "authType": "keys",
    "defaultRegion": "us-west-1"
  },
  "secureJsonData": {
    "accessKey": "Ol4pIDpeKSA6XikgOl4p",
    "secretKey": "dGVzdCBrZXkgYmxlYXNlIGRvbid0IHN0ZWFs"
  }
}

通过 ID 更新现有数据源

PUT /api/datasources/:datasourceId

警告
此 API 自 Grafana v9.0.0 起已弃用，将在未来版本中移除。请参考新的数据源更新 API。

所需权限

请参阅简介中的说明。

操作	范围
datasources:write	datasources:* datasources:id:* datasources:id:1 (单个数据源)

示例

示例请求:

PUT /api/datasources/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "id":1,
  "orgId":1,
  "name":"test_datasource",
  "type":"graphite",
  "access":"proxy",
  "url":"http://mydatasource.com",
  "password":"",
  "user":"",
  "database":"",
  "basicAuth":true,
  "basicAuthUser":"basicuser",
  "secureJsonData": {
    "basicAuthPassword": "basicpassword"
  },
  "isDefault":false,
  "jsonData":null
}

示例响应:

HTTP/1.1 200
Content-Type: application/json

{
  "datasource": {
    "id": 1,
    "uid": "kLtEtcRGk",
    "orgId": 1,
    "name": "test_datasource",
    "type": "graphite",
    "typeLogoUrl": "",
    "access": "proxy",
    "url": "http://mydatasource.com",
    "password": "",
    "user": "",
    "database": "",
    "basicAuth": true,
    "basicAuthUser": "basicuser",
    "basicAuthPassword": "",
    "withCredentials": false,
    "isDefault": false,
    "jsonData": {},
    "secureJsonFields": {
      "basicAuthPassword": true
    },
    "version": 1,
    "readOnly": false
  },
  "id": 102,
  "message": "Datasource updated",
  "name": "test_datasource"
}

注意
与创建数据源类似，password 和 basicAuthPassword 应在 secureJsonData 下定义，以便安全地存储为数据库中的加密 blob。然后，响应会在 secureJsonFields 部分中列出加密字段。

更新现有数据源

PUT /api/datasources/uid/:uid

所需权限

请参阅简介中的说明。

操作	范围
datasources:write	datasources:* datasources:uid:* datasources:uid:kLtEtcRGk (单个数据源)

示例

示例请求:

PUT /api/datasources/uid/kLtEtcRGk HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "id":1,
  "uid": "updated UID",
  "orgId":1,
  "name":"test_datasource",
  "type":"graphite",
  "access":"proxy",
  "url":"http://mydatasource.com",
  "password":"",
  "user":"",
  "database":"",
  "basicAuth":true,
  "basicAuthUser":"basicuser",
  "secureJsonData": {
    "basicAuthPassword": "basicpassword"
  },
  "isDefault":false,
  "jsonData":null
}

示例响应:

HTTP/1.1 200
Content-Type: application/json

{
  "datasource": {
    "id": 1,
    "uid": "updated UID",
    "orgId": 1,
    "name": "test_datasource",
    "type": "graphite",
    "typeLogoUrl": "",
    "access": "proxy",
    "url": "http://mydatasource.com",
    "password": "",
    "user": "",
    "database": "",
    "basicAuth": true,
    "basicAuthUser": "basicuser",
    "basicAuthPassword": "",
    "withCredentials": false,
    "isDefault": false,
    "jsonData": {},
    "secureJsonFields": {
      "basicAuthPassword": true
    },
    "version": 1,
    "readOnly": false
  },
  "id": 102,
  "message": "Datasource updated",
  "name": "test_datasource"
}

注意
与创建数据源类似，password 和 basicAuthPassword 应在 secureJsonData 下定义，以便安全地存储为数据库中的加密 blob。然后，响应会在 secureJsonFields 部分中列出加密字段。## 通过 ID 更新现有数据源

通过 ID 删除现有数据源

DELETE /api/datasources/:datasourceId

警告
此 API 自 Grafana v9.0.0 起已弃用，将在未来版本中移除。请参考通过 UID 删除现有数据源的 API 或通过名称删除现有数据源的 API

所需权限

请参阅简介中的说明。

操作	范围
datasources:delete	datasources:* datasources:id:* datasources:id:1 (单个数据源)

示例

示例请求:

DELETE /api/datasources/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

示例响应:

HTTP/1.1 200
Content-Type: application/json

{"message":"Data source deleted"}

通过 UID 删除现有数据源

DELETE /api/datasources/uid/:uid

所需权限

请参阅简介中的说明。

操作	范围
datasources:delete	datasources:* datasources:uid:* datasources:uid:kLtEtcRGk (单个数据源)

示例

示例请求

DELETE /api/datasources/uid/kLtEtcRGk HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

示例响应:

HTTP/1.1 200
Content-Type: application/json

{
    "message": "Data source deleted",
    "id": 1
}

通过名称删除现有数据源

DELETE /api/datasources/name/:datasourceName

所需权限

请参阅简介中的说明。

操作	范围
datasources:delete	datasources:* datasources:name:* datasources:name:test_datasource (单个数据源)

示例

示例请求:

DELETE /api/datasources/name/test_datasource HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

示例响应:

HTTP/1.1 200
Content-Type: application/json

{
  "message":"Data source deleted",
  "id": 1
}

通过 ID 进行数据源代理调用

警告
此 API 自 Grafana v9.0.0 起已弃用，将在未来版本中移除。请参考用于代理请求的新数据源 API。

GET /api/datasources/proxy/:datasourceId/*

代理所有对由 datasourceId 标识的实际数据源的调用。

数据源代理调用

GET /api/datasources/proxy/uid/:uid/*

代理所有对由 uid 标识的实际数据源的调用。

通过 ID 检查数据源运行状况

警告： 此 API 自 Grafana v9.0.0 版本起已弃用，将在未来版本中删除。请参考新的数据源运行状况检查 API。

GET /api/datasources/:datasourceId/health

调用由给定 datasourceId 标识的数据源的运行状况端点。这不是强制性的 - 每个插件作者都必须在其插件中实现对运行状况检查的支持。

示例

示例请求:

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

示例响应:

HTTP/1.1 200
Content-Type: application/json

{
  "message": "1. Successfully queried the CloudWatch metrics API.\n2. Successfully queried the CloudWatch logs API.",
  "status": "OK"
}

检查数据源运行状况

GET /api/datasources/uid/:uid/health

调用由给定 uid 标识的数据源的运行状况端点。这不是强制性的 - 每个插件作者都必须在其插件中实现对运行状况检查的支持。

示例

示例请求:

GET api/datasources/uid/P8045C56BDA891CB2/health HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

示例响应:

HTTP/1.1 200
Content-Type: application/json

{
  "message": "1. Successfully queried the CloudWatch metrics API.\n2. Successfully queried the CloudWatch logs API.",
  "status": "OK"
}

通过 ID 获取数据源资源

警告
此 API 自 Grafana v9.0.0 版本起已弃用，将在未来版本中删除。请参考新的数据源资源 API。

GET /api/datasources/:datasourceId/resources/*

调用由给定 dashboardId 标识的数据源的资源端点。

示例

示例请求:

GET api/datasources/112/resources/dimension-keys?region=us-east-2&namespace=AWS%2FEC2&dimensionFilters=%7B%7D&metricName=CPUUtilization HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

示例响应:

HTTP/1.1 200
Content-Type: application/json

[
	{
		"text": "AutoScalingGroupName",
		"value": "AutoScalingGroupName",
		"label": "AutoScalingGroupName"
	},
	{
		"text": "ImageId",
		"value": "ImageId",
		"label": "ImageId"
	},
	{
		"text": "InstanceId",
		"value": "InstanceId",
		"label": "InstanceId"
	},
	{
		"text": "InstanceType",
		"value": "InstanceType",
		"label": "InstanceType"
	}
]

获取数据源资源

GET /api/datasources/uid/:uid/resources/*

调用由给定 uid 标识的数据源的资源端点。

示例

示例请求:

GET api/datasources/uid/P8045C56BDA891CB2/resources/dimension-keys?region=us-east-2&namespace=AWS%2FEC2&dimensionFilters=%7B%7D&metricName=CPUUtilization HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

示例响应:

HTTP/1.1 200
Content-Type: application/json

[
	{
		"text": "AutoScalingGroupName",
		"value": "AutoScalingGroupName",
		"label": "AutoScalingGroupName"
	},
	{
		"text": "ImageId",
		"value": "ImageId",
		"label": "ImageId"
	},
	{
		"text": "InstanceId",
		"value": "InstanceId",
		"label": "InstanceId"
	},
	{
		"text": "InstanceType",
		"value": "InstanceType",
		"label": "InstanceType"
	}
]

查询数据源

查询具有后端实现的数据源。

POST /api/ds/query

注意
Grafana 的内置数据源通常具有后端实现。

Test 数据源的示例请求:

POST /api/ds/query HTTP/1.1
Accept: application/json
Content-Type: application/json

{
   "queries":[
      {
         "refId":"A",
         "scenarioId":"csv_metric_values",
         "datasource":{
            "uid":"PD8C576611E62080A"
         },
         "format": "table"
         "maxDataPoints":1848,
         "intervalMs":200,
         "stringInput":"1,20,90,30,5,0",
      }
   ],
   "from":"now-5m",
   "to":"now"
}

JSON 正文架构

from/to – 指定查询的时间范围。时间可以是毫秒级的纪元时间戳，也可以使用 Grafana 时间单位进行相对指定。例如，now-5m。
queries – 指定一个或多个查询。必须包含至少 1 个查询。
queries.datasource.uid – 指定要查询的数据源的 UID。请求中的每个查询都必须具有唯一的 datasource。
queries.refId – 指定查询的标识符。默认值为“A”。
queries.format – 指定应以何种格式返回数据。有效选项为 time_series 或 table，具体取决于数据源。
queries.maxDataPoints - 指定仪表盘面板可以渲染的最大数据点数。默认值为 100。
queries.intervalMs - 指定时间序列时间间隔（以毫秒为单位）。默认值为 1000。

此外，每个数据源的特定属性应添加到请求中（例如，如上所示请求中的 queries.stringInput）。要更好地了解如何为特定数据源形成查询，请使用您选择的浏览器的开发者工具，并检查正在向 /api/ds/query 发出的 HTTP 请求。

Test 数据源时间序列查询响应的示例

{
  "results": {
    "A": {
      "frames": [
        {
          "schema": {
            "refId": "A",
            "fields": [
              {
                "name": "time",
                "type": "time",
                "typeInfo": {
                  "frame": "time.Time"
                }
              },
              {
                "name": "A-series",
                "type": "number",
                "typeInfo": {
                  "frame": "int64",
                  "nullable": true
                }
              }
            ]
          },
          "data": {
            "values": [
              [1644488152084, 1644488212084, 1644488272084, 1644488332084, 1644488392084, 1644488452084],
              [1, 20, 90, 30, 5, 0]
            ]
          }
        }
      ]
    }
  }
}

状态代码

代码	描述
200	所有数据源查询都返回了成功的响应。
400	由于 JSON 无效、缺少内容类型、缺少或无效字段等原因导致的错误请求。或者，一个或多个数据源查询不成功。请参考正文以获取更多详细信息。
403	访问被拒绝。
404	无法找到执行请求所需的数据源或插件。
500	意外错误。请参考正文和/或服务器日志以获取更多详细信息。

此页面是否有帮助？

社区

反馈

相关资源

反馈

数据源 API

获取所有数据源

示例

通过 ID 获取单个数据源

示例

通过 UID 获取单个数据源

示例

通过名称获取单个数据源

示例

通过名称获取数据源 ID

示例

创建数据源

示例

通过 ID 更新现有数据源

示例

更新现有数据源

示例

通过 ID 删除现有数据源

示例

通过 UID 删除现有数据源

示例

通过名称删除现有数据源

示例

通过 ID 进行数据源代理调用

数据源代理调用

通过 ID 检查数据源运行状况

示例

检查数据源运行状况

示例

通过 ID 获取数据源资源

示例

获取数据源资源

示例

查询数据源

状态代码

此页面是否有帮助？

相关文档

数据源 API

获取所有数据源

示例

通过 ID 获取单个数据源

示例

通过 UID 获取单个数据源

示例

通过名称获取单个数据源

示例

通过名称获取数据源 ID

示例

创建数据源

示例

通过 ID 更新现有数据源

示例

更新现有数据源

示例

通过 ID 删除现有数据源

示例

通过 UID 删除现有数据源

示例

通过名称删除现有数据源

示例

通过 ID 进行数据源代理调用

数据源代理调用

通过 ID 检查数据源运行状况

示例

检查数据源运行状况

示例

通过 ID 获取数据源资源

示例

获取数据源资源

示例

查询数据源

状态代码

此页面是否有帮助？

相关文档

来自 Grafana Labs 的相关资源