跳至內容
CLI 概觀

CLI 概觀

Status200 的 CLI,即 status200,讓你在終端機或指令碼中管理 Status200 專案。它使用專案的 API 金鑰,列出、讀取、建立、更改、刪除和統計監測器、事件、警示、狀態頁面以及 Status200 API 提供的其他記錄。

CLI 的運作方式

每個命令向 Status200 的 REST API 傳送一次請求,並印出回應。CLI 從旗標、環境變數或 status200 login 儲存的情境中取得 API 金鑰和你的 Status200 位址。命令能讀取和更改什麼由金鑰決定,和 API 完全一樣。

flowchart TB T["你的終端機<br/>或 CI 作業"] -->|"status200 incident list"| C["status200 CLI"] K["API 金鑰和 URL:<br/>旗標、環境變數<br/>或儲存的情境"] --> C C -->|"POST /api/incident/get-list"| A["Status200 REST API"] A -->|"金鑰可讀取的記錄,<br/>以 JSON 傳回"| C C -->|"終端機裡是表格,<br/>管道裡是 JSON"| T

一個命令,一次請求

記錄的命令隨 CLI 一起提供:Status200 API 向工具開放的每種記錄都有一個,與 MCP 伺服器 提供工具的記錄相同。執行 status200 resources 即可列出它們。

開始之前

  • Node.js 和 npm:目前的 LTS 版本,用於安裝 CLI。
  • 專案的 API 金鑰。 在 專案設定 → 進階 → API 金鑰 中透過 建立API 金鑰 建立:請參閱 建立 API 金鑰。
  • 在 Status200 Cloud 上,需要 Growth 方案或更高。 專案的 API 金鑰只在該方案上有效:請參閱 低於其方案時的 API 金鑰和 SCIM。

安裝 CLI

從 npm 安裝 @status200/cli 套件。它會新增 status200 命令,--version 會印出你安裝的版本:

Bash
npm install -g @status200/cli
status200 --version

CLI 與 Status200 一同發布,版本號也相同。在自行託管的 Status200 上,請安裝與你的 Status200 版本相同的 CLI,讓它的命令與你伺服器上的記錄一致:

Bash
npm install -g @status200/cli@<your-oneuptime-version>

執行你的第一批命令

  1. 儲存你的 API 金鑰

    用金鑰和你的 Status200 位址登入。CLI 會把它們儲存為名為 default 的情境,並從此使用它:

    Bash
    status200 login <your-api-key> https://status200.ru

    它回應 Logged in successfully. Context "default" is now active.。在自行託管的 Status200 上,請用它的位址代替 https://status200.ru。

  2. 列出你的事件

    Bash
    status200 incident list

    最新的十個事件以表格顯示。login 儲存金鑰時不會檢查它,所以這個命令是第一個能證明金鑰可用的命令:如果被拒絕,請參閱 疑難排解。

  3. 看看還能管理什麼

    Bash
    status200 resources

    清單顯示你可以處理的每種記錄及其命令,例如 monitor、status-page 或 on-call-policy。

命令一覽

命令作用瞭解更多
status200 login <api-key> <instance-url>將 API 金鑰和位址儲存為情境驗證
status200 context list, use, current, delete列出、切換、顯示和刪除已儲存的情境驗證
status200 whoami顯示下一個命令將使用的 URL 和 API 金鑰驗證
status200 deploy為圖表和 Status200 AI 記錄一次部署或其他變更部署與變更
status200 <resource> list, get, create, update, delete, count處理一種記錄資源操作
status200 resources列出各種記錄及其命令命令參考
status200 version印出 CLI 的版本命令參考
status200 help [command]顯示命令的說明取得說明

全域選項

這些選項適用於每個命令,寫在命令前後均可:

選項作用
--api-key <key>此命令使用的 API 金鑰,代替已儲存的金鑰
--url <url>此命令使用的 Status200 位址
--context <name>此命令使用的已儲存情境,代替目前情境
-o, --output <format>table、json 或 wide:請參閱 輸出格式
--no-color不帶顏色地印出
-V, --version印出 CLI 的版本
-h, --help顯示命令的說明

取得說明

每個命令都有自己的說明,列出它的引數、選項和預設值:

Bash
status200 --help
status200 help incident
status200 incident list --help

後續步驟