專案與用戶管理 API 參考

引導您如何透過程式化方式查詢專案資訊並管理 GIIP 平臺內的用戶權限。

🔌 前往專案列表功能頁 →

📋 概述

此 API 模組提供了對接 GIIP 系統邏輯管理單元——專案 (Project) 以及可訪問該專案的用戶 (User) 資訊的控制功能。

🔐 認證與請求頭

所有請求必須包含通用的認證請求頭。

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

🚀 核心 API 端點

1. 查詢專案列表 (Get Project List)

URL:
```
POST /api/project/list
```
描述: 返回當前帳號 (CSN) 下可訪問的所有專案列表。
請求體 (Request Body):

{
  "searchKeyword": ""
}

2. 查詢專案詳情 (Get Project Detail)

URL:
```
POST /api/project/detail
```
描述: 查詢特定專案的詳細設置及已分配的資產數量。
請求體 (Request Body):

{
  "projectIsn": 123
}

3. 查詢專案用戶列表 (Get Project Users)

URL:
```
POST /api/project/users
```
描述: 查詢分配至特定專案的用戶列表及其各自的權限等級。
請求體 (Request Body):

{
  "projectIsn": 123
}

🔍 響應數據示例

{
  "RstVal": 0,
  "RstMsg": "Success",
  "Data": [
    {
      "projectIsn": 123,
      "projectName": "Mobile App Backend",
      "userCount": 5,
      "serverCount": 12,
      "dbCount": 2
    }
  ]
}

💡 使用場景

CI/CD 流水線: 在部署前透過 API 獲取目標專案的伺服器列表，以觸發並行的包更新。
權限審計: 定期導出各專案的用戶權限列表，用於編寫安全報告。

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

在進行新增專案註冊或修改服務組等影響基礎設施整體架構的管理操作時，為了確保操作的一致性並獲取詳細的審計日誌 (Audit Log)，建議使用

giipApiSk3

端點。

端點:

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

優勢: 若專案創建失敗，系統會立即記錄調用者的詳細環境資訊 (IP, UA) 和堆疊追蹤 (StackTrace)，助力快速分析配置錯誤或權限問題。
使用技巧: 靈活運用
```
text
```
命令和
```
jsondata
```
的參數替換功能，確保開發的伺服器組說明或非英語名稱等資訊能完整、安全地得到管理。

🔧 疑難排解

症狀	原因	解決方法
請求因認證錯誤被拒絕	缺少通用認證請求頭（ `x-giip-ak` / `x-giip-sk` ）	確認每個請求都包含兩個認證請求頭
`PrjPut` 調用失敗或專案未創建	`text` 命令簽名（ `PrjPut <cCode>, '<cName>'` ）不正確	使用唯一的 `cCode` 和用引號包裹的 `cName` ，按準確格式重新調用
`PrjDel` 響應中的 `RstVal` 不為 0	指定了錯誤的 CSN，或刪除權限不足	核對正確的 CSN，並確認擁有刪除專案所需的管理員權限
`PrjGrpPut` 的中文/特殊字元名稱出現亂碼	`text` 字串中的特殊字元未轉義	在 `giipApiSk3` 上使用 `jsondata` 參數替換功能，以無損方式傳輸名稱

版本: 1.1 最後更新: 2026-04-11 源碼:

giipv3/public/help/api-project-user.zh-TW.md

相關文檔:

API 結果代碼指南 (RstVal)