跳至文檔內容
開發者文檔API 參考查詢防火牆清單
GETBearer 權杖

查詢防火牆清單

/api/v1/firewalls

查詢組織與系統防火牆、規則及套用的伺服器。系統防火牆不可編輯。

API 欄位名稱、型別與程式碼在所有語言中保持原樣。

請求範例

cURL
curl "https://tovahub.com/api/v1/firewalls" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

僅提供範例,此頁不會發送 API 請求。

回應示例
JSON
[]

參數

無參數。

回應

HTTP 狀態 200

回傳目前組織與系統防火牆資源的陣列。

[]array

回應最外層為陣列,不會包在 firewalls 欄位內。

[].idstring

平台端防火牆識別碼;共用系統資源則為 system。

[].systemboolean

是否為系統防火牆。

[].providerIdstring | null

供應商防火牆識別碼(若可用)。

[].namestring

儲存的或供應商提供的防火牆名稱。

[].statestring

平台端資源狀態。

[].statusstring

供應商狀態;沒有儲存的狀態快照時為 unknown。

[].managedboolean

供應商所關聯的伺服器是否全都屬於此組織且可見。

[].rulesarray

可見的入站規則,不含供應商最後一條預設拒絕規則。

[].rules[].displayNamestring

規則名稱。

[].rules[].protocolstring

規則通訊協定。

[].rules[].destPortsstring[]

目的連接埠或範圍。

[].rules[].ipv4string[]

IPv4 來源。

[].rules[].ipv6string[]

IPv6 來源。

[].rules[].actionstring

供應商規則動作。

[].rules[].statusstring

供應商規則狀態。

[].serversarray

可見且已關聯的組織伺服器。

[].servers[].idstring (ObjectId)

平台端伺服器識別碼。

[].servers[].namestring

主機名稱;無名稱時使用供應商執行個體 ID。

[].servers[].statusstring

供應商關聯狀態,預設為 ok。