2分钟阅读

监控数据查询 API 参考

引导您如何通过编程方式提取服务器及数据库的实时性能指标和审计日志。

🔌 前往服务监控 →

📋 概述

此 API 模块提供了将 GIIP 代理收集的海量性能数据对接至外部系统（如 Grafana、ELK 等）或进行分析的接口。

🔐 认证与请求头

所有请求必须包含通用的认证请求头。

Header: x-giip-ak: [Your Access Key]
Header: x-giip-sk: [Your Secret Key]

🚀 核心 API 端点

1. 查询实时服务器指标 (Get Real-time Metrics)

URL: POST /api/monitoring/server/current
描述: 查询特定服务器的最新性能状态（CPU、内存、磁盘）。
请求体 (Request Body):

{
  "serverIsn": 456
}

2. 查询性能历史 (Get Metric History)

URL: POST /api/monitoring/server/history
描述: 以时间序列格式返回特定时间段内的性能变化趋势数据。
请求体 (Request Body):

{
  "serverIsn": 456,
  "startTime": "2026-03-19T00:00:00Z",
  "endTime": "2026-03-19T23:59:59Z",
  "interval": "5m"
}

3. 查询进程列表 (Get Process List)

URL: POST /api/monitoring/server/processes
描述: 查询服务器上当前运行的所有进程列表及其资源占用率。
请求体 (Request Body):

{
  "serverIsn": 456
}

🔍 响应数据示例 (Metrics)

{
  "RstVal": 0,
  "RstMsg": "Success",
  "Data": {
    "cpuUsage": 12.5,
    "memUsage": 45.2,
    "diskUsage": 68.1,
    "networkIn": 1024,
    "networkOut": 512
  }
}

💡 使用场景

自定义仪表板: 将 GIIP 的实时数据嵌入到公司内部的统一监控仪表板中。
异常征兆分析: 通过性能历史 API 提取数据并输入机器学习模型，以预测故障。

🛡️ 巧用 Sk3 (高性能日志)

在进行高频监控数据采集或查询海量时序性能指标时，为了确保数据传输的完整性并实现精细的错误追踪，建议使用 giipApiSk3 端点。

端点: https://giipfaw.azurewebsites.net/api/giipApiSk3
优势: 在通过 jsondata 发送海量指标数据时，可防止数据截断；并在发生错误时自动采集助理端的详细日志，确保数据采集流水线的可靠性。
使用技巧: 将 startTime、endTime、interval 等复杂的查询条件放入 jsondata 中并调用 Sk3，可以在不丢失查询参数的情况下安全地获取统计数据。

故障排除

症状	原因	解决
认证失败 (RstVal 不为 0)	缺少或误填 `x-giip-ak` 或 `x-giip-sk` 请求头	使用有效的密钥值包含两个请求头后重试
响应数据为空	请求体中的 `serverIsn` 值错误或非数字	指定目标服务器正确的数字 `serverIsn`
性能历史查询无结果	`startTime`/`endTime` 不是 ISO 8601（如 `2026-03-19T00:00:00Z`）格式或时间段颠倒	确认正确的时间格式和 `startTime < endTime`，并指定 `interval`（如 `5m`）
大批量查询时数据被截断	通过普通端点发送大量 `jsondata`	切换到 `giipApiSk3` 端点以防止数据丢失

版本: 1.1 最后更新: 2026-04-11 源文件: giipv3/public/help/api-monitoring.zh-CN.md

相关文档:

API 结果代码指南 (RstVal)