数据库 API 参考指南

用于查询和监控 GIIP 平台注册的数据库资产详情的 API 详细规范。

🔌 前往数据库管理功能页 →

📋 概述

通过数据库 API，您可以以编程方式获取 GIIP 管理的 MariaDB、Azure SQL、MySQL 等实例信息。所有请求均需使用在 [API 参考指南概览] 中发放的 AK/SK。

🔍 核心端点

1. 查询数据库列表

获取所有已注册数据库实例的基础信息。

URL:
```
GET /database/list
```
主要参数:
- ```
csn
```
  (Integer): 按客户编号过滤
- ```
prj_isn
```
  (Integer): 仅查询特定项目所属的数据库

响应示例:

{
  "RstVal": 1,
  "Data": [
    { "isn": 101, "db_name": "Prod_DB", "engine": "AzureSQL", "status": "Running" }
  ]
}

2. 查询数据库性能指标

查询特定数据库的实时或历史性能数据。

URL:
```
GET /database/metrics
```
必填参数:
```
db_isn
```
(数据库唯一编号)
响应数据: CPU 使用率、数据输入输出 (IOPS)、剩余空间等

3. 查询当前连接会话

获取当前连接到数据库的实时会话列表。

URL:
```
GET /database/sessions
```
用途: 核实是否存在来自特定 IP 的异常过量连接

🛠️ 代码示例 (Python)

import requests

headers = {"x-giip-ak": "YOUR_AK"}
response = requests.get("https://api.giip.io/v3/database/list", headers=headers)
db_list = response.json()["Data"]

for db in db_list:
    print(f"数据库: {db['db_name']} | 状态: {db['status']}")

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

为了确保数据库资产数据传输的完整性并保留详细的调用历史，建议使用

giipApiSk3

端点。

端点:

https://giipfaw.azurewebsites.net/api/giipApiSk3

优势: 自动检测助理错误、自动记录调用者 IP 及会话信息、优化复杂数据库查询参数的传递。
使用技巧: 将
```
text
```
命令与
```
jsondata
```
结合使用，可以在不丢失数据的情况下，安全地发送带有多种过滤条件的数据库列表查询或性能指标采集请求。

故障排除

症状	原因	解决
返回 401 认证错误	缺少或错误的 `x-giip-ak` (AK/SK) 标头	确认请求标头中包含已发放的有效 AK/SK。
`/database/metrics` 返回空数据	缺少必填参数 `db_isn`	务必传递数据库唯一编号 ( `db_isn` )。
`RstVal` 返回非 1 的值	`csn` / `prj_isn` 格式错误或权限不足	以整数形式发送参数，并查阅 API 结果代码指南。
Sk3 调用时 `jsondata` 解析失败	JSON 转义/编码错误	将 `jsondata` 转义为有效的 JSON 后再发送。

版本: 1.1 最后更新: 2026-04-11 源文件:

giipv3/public/help/api-database.zh-CN.md

相关文档:

API 结果代码指南 (RstVal)