API 參考

工作區

更新目前工作區

更新工作區嘅 name 同 status，兩個欄位都必填；status 淨係接受 active / inactive，inactive 會令全部 API Key 無法認證。唔傳 metadata 會保留現值，傳 metadata={} 代表清空，唔可以傳 null。

PATCHhttps://api.unifyport.ai/v1/workspace

呼叫前準備

在伺服器端使用資源所屬工作區的 X-Api-Key，執行範例前替換所有預留位置。

請求參數

請求標頭

X-Api-Key
string必填

工作區 API Key，工作區會由呢個標頭解析得出嚟。

Content-Type
string必填

發送 JSON 請求內容嘅時候請用 application/json。

請求內容

name
string必填

工作區嘅顯示名稱。

minLength: 1

status
string必填

工作區狀態：active 或 inactive；inactive 會令全部 API Key 無法認證。

enum: active, inactive

metadata
object

工作區中繼資料。PATCH 時唔傳代表保留，傳 {} 代表清空，null 無效。

如何理解結果

依文件解讀回應欄位與 HTTP 狀態。204 成功沒有回應本文，排查時使用 X-Request-Id。下一步請參閱相關操作。

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "name": "Production Workspace",
    "status": "active",
    "metadata": {
      "region": "global",
      "env": "production"
    },
    "account_quota": 10,
    "account_quota_used": 1,
    "account_quota_unlimited": false
  }
}

回應內容

name
string

工作區嘅顯示名稱。

status
string

工作區狀態：active 或 inactive；inactive 時全部 API Key 無法認證。

enum: active, inactive

metadata
object

你自己存喺工作區上面嘅環境標籤。

account_quota
integer

目前生效嘅唯讀帳號總容量，包含免費額度同有效期內嘅付費額度，唔扣除已用數量；已到期嘅付費額度唔會計入。

format: uint64

account_quota_used
integer

目前已佔用嘅唯讀帳號額度，建立帳號後即佔用，刪除後釋放；等待授權、停止或斷線嘅帳號仍會計入。付費額度到期後，已用額度可能超過 account_quota，會返回實際已用值。

format: uint64

account_quota_unlimited
boolean

為兼容而保留嘅唯讀欄位，目前配額模式固定返回 false；帳號容量以 account_quota 為準。

回應

200

200 OK

請求成功，回應內容嘅例子如上。

400

請求錯誤

請求內容、路徑或者參數無效。

401

未授權

X-Api-Key 請求標頭缺少或者無效。

500

伺服器錯誤

服務遇到咗未預期嘅錯誤。

失敗後如何處理

檢查 HTTP 狀態和 error.code/numeric_code，保留 request_id。依原因修正參數、繼續授權或檢查狀態。重試傳送及寫入前確認上次結果，避免重複操作。 錯誤碼參考

invalid_request · 10000 · 400
檢查必填欄位、格式與渠道條件，修正請求後再呼叫。
invalid_api_key · 11001 · 401
檢查 X-Api-Key 與工作區是否有效。