資料庫 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-TW.md

相關文檔:

API 結果代碼指南 (RstVal)