Kibana

通过托管的API认证访问Kibana已保存对象、仪表板、数据视图、空间、告警和Fleet。

快速开始

bash
python < import urllib.request, os, json
req = urllib.request.Request(https://gateway.maton.ai/kibana/api/savedobjects/find?type=dashboard)
req.addheader(Authorization, fBearer {os.environ[MATONAPI_KEY]})
req.add_header(kbn-xsrf, true)
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

基础URL

https://gateway.maton.ai/kibana/{原生API路径}

网关将请求代理到您的Kibana实例，并自动注入认证信息。

认证

所有请求都需要Maton API密钥和kbn-xsrf请求头：

Authorization: Bearer $MATONAPIKEY
kbn-xsrf: true

环境变量： 将您的API密钥设置为MATONAPIKEY：

bash
export MATONAPIKEY=YOURAPIKEY

获取您的API密钥

1. 1. 在maton.ai登录或创建账户
2. 前往maton.ai/settings
3. 复制您的API密钥

连接管理

在https://ctrl.maton.ai管理您的Kibana连接。

列出连接

bash
python < import urllib.request, os, json
req = urllib.request.Request(https://ctrl.maton.ai/connections?app=kibana&status=ACTIVE)
req.addheader(Authorization, fBearer {os.environ[MATONAPI_KEY]})
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

创建连接

bash
python < import urllib.request, os, json
data = json.dumps({app: kibana}).encode()
req = urllib.request.Request(https://ctrl.maton.ai/connections, data=data, method=POST)
req.addheader(Authorization, fBearer {os.environ[MATONAPI_KEY]})
req.add_header(Content-Type, application/json)
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

在浏览器中打开返回的url以完成认证。您需要提供您的Kibana API密钥。

删除连接

bash
python < import urllib.request, os, json
req = urllib.request.Request(https://ctrl.maton.ai/connections/{connection_id}, method=DELETE)
req.addheader(Authorization, fBearer {os.environ[MATONAPI_KEY]})
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

API参考

重要提示： 所有Kibana API请求都需要kbn-xsrf: true请求头。

状态与功能

获取状态

bash
GET /kibana/api/status

响应：
json
{
name: kibana,
uuid: abc123,
version: {
number: 8.15.0,
build_hash: ...
},
status: {
overall: {level: available}
}
}

列出功能

bash
GET /kibana/api/features

返回所有Kibana功能及其能力的列表。

已保存对象

查找已保存对象

bash
GET /kibana/api/savedobjects/find?type={type}

查询参数：

• - type - 对象类型：dashboard、visualization、index-pattern、search、lens、map
• search - 搜索查询
• page - 页码
• per_page - 每页结果数（默认20，最大10000）
• fields - 返回的字段

响应：
json
{
page: 1,
per_page: 20,
total: 5,
saved_objects: [
{
id: abc123,
type: dashboard,
attributes: {
title: 我的仪表板,
description: 仪表板描述
},
version: 1,
updated_at: 2024-01-01T00:00:00.000Z
}
]
}

获取已保存对象

bash
GET /kibana/api/saved_objects/{type}/{id}

创建已保存对象

bash
POST /kibana/api/saved_objects/{type}/{id}
Content-Type: application/json

{
attributes: {
title: 我的索引模式,
timeFieldName: @timestamp
}
}

更新已保存对象

bash
PUT /kibana/api/saved_objects/{type}/{id}
Content-Type: application/json

{
attributes: {
title: 更新后的标题
}
}

删除已保存对象

bash
DELETE /kibana/api/saved_objects/{type}/{id}

批量操作

bash
POST /kibana/api/savedobjects/bulk_get
Content-Type: application/json

[
{type: dashboard, id: abc123},
{type: visualization, id: def456}
]

数据视图

列出数据视图

bash
GET /kibana/api/data_views

响应：
json
{
data_view: [
{
id: abc123,
title: logs-*,
timeFieldName: @timestamp
}
]
}

获取数据视图

bash
GET /kibana/api/dataviews/dataview/{id}

创建数据视图

bash
POST /kibana/api/dataviews/dataview
Content-Type: application/json

{
data_view: {
title: logs-*,
timeFieldName: @timestamp
}
}

响应：
json
{
data_view: {
id: abc123,
title: logs-*,
timeFieldName: @timestamp
}
}

更新数据视图

bash
POST /kibana/api/dataviews/dataview/{id}
Content-Type: application/json

{
data_view: {
title: updated-logs-*
}
}

删除数据视图

bash
DELETE /kibana/api/dataviews/dataview/{id}

空间

列出空间

bash
GET /kibana/api/spaces/space

响应：
json
[
{
id: default,
name: 默认,
description: 默认空间,
disabledFeatures: []
}
]

获取空间

bash
GET /kibana/api/spaces/space/{id}

创建空间

bash
POST /kibana/api/spaces/space
Content-Type: application/json

{
id: marketing,
name: 市场营销,
description: 市场营销团队空间,
disabledFeatures: []
}

更新空间

bash
PUT /kibana/api/spaces/space/{id}
Content-Type: application/json

{
id: marketing,
name: 市场营销团队,
description: 更新后的描述
}

删除空间

bash
DELETE /kibana/api/spaces/space/{id}

告警

查找告警规则

bash
GET /kibana/api/alerting/rules/_find

查询参数：

• - search - 搜索查询
• page - 页码
• per_page - 每页结果数

响应：
json
{
page: 1,
per_page: 10,
total: 5,
data: [
{
id: abc123,
name: CPU告警,
consumer: alerts,
enabled: true,
ruletypeid: metrics.alert.threshold
}
]
}

获取告警规则

bash
GET /kibana/api/alerting/rule/{id}

启用/禁用规则

bash
POST /kibana/api/alerting/rule/{id}/_enable
POST /kibana/api/alerting/rule/{id}/_disable

静音/取消静音规则

bash
POST /kibana/api/alerting/rule/{id}/muteall
POST /kibana