Monitoring Data Query API Reference

Learn about the APIs for programmatically extracting real-time performance metrics and audit logs for servers and databases.

🔌 Go to Service Monitoring →

📋 Overview

This API module provides an interface to integrate or analyze vast amounts of performance data collected by GIIP agents into external systems (e.g., Grafana, ELK).

🔐 Authentication & Headers

All requests must include common authentication headers.

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

🚀 Key API Endpoints

1. Get Real-time Server Metrics

• URL: POST /api/monitoring/server/current
• Description: Queries the most recent performance status (CPU, MEM, Disk) of a specific server.
• Request Body:

{
  "serverIsn": 456
}

2. Get Metric History

• URL: POST /api/monitoring/server/history
• Description: Returns time-series data of performance change trends over a specific period.
• 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
• Description: Queries the entire list of processes currently running on the server and their resource occupancy.
• Request Body:

{
  "serverIsn": 456
}

🔍 Response Data Example (Metrics)

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

💡 Use Cases

• Custom Dashboard: Embed GIIP's real-time data into your company's internal integrated control dashboard.
• Anomaly Analysis: Extract data via the performance history API to input into machine learning models and predict failures.

🛡️ Using Sk3 (High-fidelity Logging)

For high-frequency monitoring data collection or querying large volumes of time-series performance metrics, we recommend the giipApiSk3 endpoint to ensure data transmission integrity and sophisticated error tracking.

• Endpoint: https://giipfaw.azurewebsites.net/api/giipApiSk3
• Advantages: Prevents data truncation when sending large amounts of metric data via jsondata and ensures the reliability of your data collection pipeline by automatically collecting detailed logs from the agent side in case of errors.
• Usage Tip: By putting complex query conditions like startTime, endTime, and interval into jsondata and calling Sk3, you can securely obtain statistical data without losing query parameters.

---

Troubleshooting

Symptom	Cause	Solution
Authentication failure (RstVal not 0)	Missing or mistyped x-giip-ak or x-giip-sk header	Include both headers with valid key values and retry
Response data is empty	The serverIsn in the request body is wrong or not numeric	Specify the correct numeric serverIsn for the target server
Metric history returns no results	startTime/endTime is not ISO 8601 (e.g., 2026-03-19T00:00:00Z) or the range is reversed	Verify the time format and startTime < endTime, and set interval (e.g., 5m)
Data truncated on large queries	Large jsondata sent via the standard endpoint	Switch to the giipApiSk3 endpoint to prevent data loss

---

Version: 1.1 Last Updated: 2026-04-10 Source: giipv3/public/help/api-monitoring.en.md

---

Related Documents:

• API Result Codes Guide (RstVal)