工作區
取得目前工作區
回傳與 X-Api-Key 請求標頭關聯的工作區。請求內容中無需再傳 workspace_id。 is_beta 是預設關閉的唯讀工作區標記。請聯絡平台開通，不能透過 PATCH 或 metadata 自行修改。
https://api.unifyport.ai/v1/workspace支援渠道
呼叫前準備
在伺服器端使用資源所屬工作區的 X-Api-Key，執行範例前替換所有預留位置。
請求參數
請求標頭
X-Api-Key工作區 API Key，工作區會由此標頭解析得到。
請求內容
此介面無需 JSON 請求內容。
如何理解結果
依文件解讀回應欄位與 HTTP 狀態。204 成功沒有回應本文，排查時使用 X-Request-Id。下一步請參閱相關操作。
回應 200 OK
{
"request_id": "<REQUEST_ID>",
"data": {
"name": "Production Workspace",
"status": "active",
"metadata": {
"env": "production"
},
"account_quota": 10,
"account_quota_used": 1,
"account_quota_unlimited": false,
"is_beta": false
}
}
回應內容
name工作區顯示名稱。
status工作區狀態：active 或 inactive；inactive 時全部 API Key 無法認證。
enum: active, inactive
metadata儲存於工作區、面向自有環境的標籤。
account_quota目前生效的唯讀帳號總容量，包含免費額度和有效期內的付費額度，不扣除已使用數量；已到期的付費額度不計入。
format: uint64
account_quota_used目前已佔用的唯讀帳號額度，帳號建立後即佔用，刪除後釋放；待授權、停止或斷線的帳號仍計入。付費額度到期後，已用額度可能超過 account_quota，按實際已用值返回。
format: uint64
account_quota_unlimited為相容性保留的唯讀欄位，目前配額模式固定返回 false；帳號容量以 account_quota 為準。
is_betais_beta 是預設關閉的唯讀工作區標記。請聯絡平台開通，不能透過 PATCH 或 metadata 自行修改。
回應
200200 OK
請求成功，回應內容範例如上。
401未授權
X-Api-Key 請求標頭缺少或無效。
500伺服器錯誤
服務遇到了未預期的錯誤。
失敗後如何處理
檢查 HTTP 狀態和 error.code/numeric_code，保留 request_id。依原因修正參數、繼續授權或檢查狀態。重試傳送及寫入前確認上次結果，避免重複操作。 錯誤碼參考
- invalid_request · 10000 · 400
- 檢查必填欄位、格式與渠道條件，修正請求後再呼叫。
- invalid_api_key · 11001 · 401
- 檢查 X-Api-Key 與工作區是否有效。