保存 Grafana 工具连接¶

为当前工作区保存 Grafana 工具连接。服务账号令牌仅用于建立或更新凭据，成功响应不会回显令牌。

POST https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/tools/grafana/connect

调用前准备¶

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

路径参数¶

参数	类型	是否必填	说明
`workspace_id`	string	是	当前工作区 ID。

请求体¶

调用示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/tools/grafana/connect" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "grafana_url": "https://grafana.example.com",
    "service_account_token": "<SERVICE_ACCOUNT_TOKEN>"
  }'

参数说明

参数	类型	是否必填	说明
`grafana_url`	string	是	Grafana 基础 URL，协议只能为 `http` 或 `https`；不能包含凭据、查询参数、片段或以 `/api` 结尾的路径。
`service_account_token`	string	是	Grafana 服务账号令牌本身，不要包含 `Bearer` 前缀，也不能包含空白字符或路径分隔符。

成功响应¶

响应示例

{
  "code": 0,
  "data": {
    "tool_id": "moi.grafana.tools",
    "grafana_url": "https://grafana.example.com",
    "credential_ref": "cred_01",
    "status": "connected",
    "connected_at": "2026-01-02T15:04:05Z",
    "requires_reconnect": false
  }
}

字段说明

成功时返回 200。重新连接会更新工作区中的 Grafana 连接。

响应字段如下。

通用字段

字段	类型	说明
`code`	integer	成功时为 `0`。

基本信息

字段	类型	说明
`tool_id`	string	Grafana 内置工具标识。
`grafana_url`	string	已保存的 Grafana 基础 URL。
`credential_ref`	string	已保存凭据的引用，不是服务账号令牌。
`status`	string	连接状态和是否需要重新连接。
`requires_reconnect`	boolean	连接状态和是否需要重新连接。
`connected_at`	string	建立连接的时间，使用 RFC 3339 格式。

错误响应¶

响应示例

{
  "code": 2,
  "message": "<错误信息>"
}

字段说明

常见 HTTP 错误

通用字段

字段	类型	说明
`400`	`2`（`INVALID_ARGUMENT`）	常见原因：URL、服务账号令牌或请求体无效。建议操作：使用不含凭据和 `/api` 后缀的 Grafana 基础 URL，并检查令牌格式。
`401`	`6`（`UNAUTHENTICATED`）	常见原因：缺少有效身份凭据。建议操作：检查 API Key。
`403`	`5`（`PERMISSION_DENIED`）	常见原因：当前身份没有在工作区中管理工具连接的权限。建议操作：检查工作区授权。
`503`	`15`（`UNAVAILABLE`）	常见原因：Grafana 工具连接服务或授权依赖暂不可用。建议操作：稍后重试。

后续操作¶

保存后查询 Grafana 工具连接确认连接配置。

最后更新于 2026 年 9 月 11 日