跳至主要内容
版本:0.4 · 現行版

管理實體

操作指南審閱日期:2026年10月11日
適用於:Excubius 0.4角色: 實體管理員
方案Free · Core · Pro · Enterprise部署自行託管

實體構成容納你的資源的樹:公司、客戶、環境、團隊。你在實體上設定的內容,會由其下的所有內容繼承。本指南說明如何在 Settings › Entities 下建立及變更實體樹、在哪裏設定每個實體向下傳遞的內容,以及如何為資源加上標記,以便跨實體樹分組。

開始之前​

  • 你需要在要變更的實體上擁有 Entity admin(實體管理員)角色。建立實體時,你需要在其父實體上擁有此角色;移動實體時,你需要在該實體及其新的父實體上擁有此角色。
  • 規劃你需要的層級。實體的種類(租戶、客戶、環境、群組)只是標籤,不會改變任何行為。有關繼承的運作方式,請參閱實體、標記與繼承。

在範例中,肥土鎮科技有限公司是根實體,桃花島物流是它之下的客戶,而 Production 和 UAT 是桃花島物流的環境。

建立實體​

  1. 開啟 Settings › Entities。實體樹會顯示在選擇器中選取的實體及其下的所有內容,並顯示每個分支中的資源數目。
  2. 在父實體上(例如 桃花島物流)開啟其動作選單,然後選取 Add an entity below。
  3. 輸入 Name,例如 Production。
  4. 選擇 Kind,例如 environment。
  5. 你也可以輸入 Short name,用於路徑:小寫字母、數字和連字號,在整個安裝中必須是唯一的。留空時,系統會根據名稱產生。之後無法變更。
  6. 選取 Create。

根實體只有一個;其他每個實體都有父實體。

重新命名實體​

  1. 開啟實體的動作選單,然後選取 Rename。
  2. 變更 Name,必要時也變更 Kind。根實體的種類不能變更。
  3. 選取 Save。

簡稱保持不變,因此連結和路徑仍然有效。

移動實體​

移動實體時,其下的所有內容都會一併移動,並且從此繼承新位置的設定:閾值、Slack 頻道、維護時段、註冊和角色。

  1. 開啟實體的動作選單,然後選取 Move。
  2. 選擇 New parent。只會提供你管理的實體,而且不會提供實體本身或其下的實體。
  3. 選取 Move。

根實體不能移動。稽核記錄會記錄每次移動。

刪除實體​

當實體之下已沒有任何內容時,你就可以刪除它。

  1. 移除或移動它所包含的內容:子實體、資源和數據源。刪除資源時,也會一併刪除它的警報。
  2. 開啟實體的動作選單,然後選取 Delete。只有實體為空時才能使用此選項。
  3. 選取 Delete 以確認。實體本身的憑證、Slack 頻道和角色指派會隨之一併刪除。

如果實體之下仍有子實體、資源、數據源或警報,或者其他位置的資源使用該實體的某個憑證,Excubius 會拒絕刪除。根實體不能刪除。

設定實體向下傳遞的內容​

每個可繼承的設定都有自己的畫面。請在選擇器中選取實體,或從 Settings › Entities 開啟。

設定位置指南
每項檢查的閾值預設值Settings › Entities,動作選單,Threshold defaults變更閾值及關閉檢查
角色,以及誰可以擁有帳戶Settings › Users and roles管理用戶及角色
採集器使用的憑證Settings › Credentials為採集器儲存憑證
Slack 頻道Settings › Notifications設定 Slack 通知
維護時段Settings › Maintenance windows規劃維護時段
預設佈景主題和標誌Settings › Branch appearance設定公開狀態頁
公開狀態頁Settings › Status page設定公開狀態頁

為資源加上標記​

標記是資源上的 key:value 標籤,例如 env:prod、role:sql 或 client:ciguapa。資源只位於實體樹的一個位置,但標記可讓你把它與樹中任何位置的其他資源分在一組。

為資源加上標記:

  1. 開啟資源並選取 Edit。新增資源時,精靈中有一個 Tags 步驟,作用相同。
  2. 在 Tags 中,輸入以空格分隔的 key:value 配對,例如 env:prod role:sql client:ciguapa。鍵可以使用字母、數字、句點、連字號和底線,而且每個鍵只能出現一次。
  3. 設定 Criticality(關鍵程度),從 1(低)到 5(關鍵)。它是獨立的欄位,不是標記,用於路由、風險和安全分數。
  4. 選取 Save。

請在每個資源上至少使用 env、role 和 client,並設定關鍵程度。

使用標記的方法:

  • 在 Resources 中,輸入 Tag rule。role:sql env:prod 會顯示同時具有兩者的資源;只輸入一個鍵(例如 client),則會顯示具有該鍵的每個資源。
  • 在 Overview 中,選擇 Hex 檢視,並以標記鍵作 Group by,即可看到每個值各有一組六邊形。

使用 API 完成​

工作請求
建立POST /api/v1/entities,附帶 parent_id、name,以及選用的 kind 和 slug
重新命名或變更種類PATCH /api/v1/entities/{id},附帶 name 或 kind
移動PATCH /api/v1/entities/{id},附帶 parent_id
刪除DELETE /api/v1/entities/{id};實體不為空時,會回應 409 並附上原因
為資源加上標記PATCH /api/v1/resources/{id},附帶 tags(一個物件,例如 {"env": "prod", "role": "sql"})和 criticality