CLI 概要
Status200 の CLI である status200 は、ターミナルやスクリプトから Status200 プロジェクトを管理します。プロジェクトの API キーを使って、モニター、インシデント、アラート、ステータスページなど、Status200 の API が提供するレコードの一覧表示、読み取り、作成、変更、削除、件数の取得ができます。
CLI のしくみ
各コマンドは Status200 の REST API に 1 回リクエストを送り、応答を出力します。CLI は API キーと Status200 のアドレスを、フラグ、環境変数、または status200 login が保存したコンテキストから取得します。コマンドが何を読み取り、何を変更できるかはキーが決めます。これは API とまったく同じです。
1 つのコマンドで 1 回のリクエスト
レコード用のコマンドは CLI に含まれています。Status200 の API がツールに公開しているレコードの種類ごとに 1 つあり、MCP サーバーがツールを持つレコードと同じです。一覧を見るには status200 resources を実行します。
はじめる前に
- Node.js と npm: CLI をインストールするための、現在の LTS リリース。
- プロジェクトの API キー。 プロジェクト設定 → 詳細 → API キー で API キーを作成 から作成します。API キーを作成するを参照してください。
- Status200 Cloud では Growth プラン以上。 プロジェクトの API キーはこのプランでのみ動作します。プラン未満の API キーと SCIMを参照してください。
CLI をインストールする
npm から @status200/cli パッケージをインストールします。status200 コマンドが追加され、--version でインストールしたバージョンが表示されます。
npm install -g @status200/cli
status200 --versionCLI は Status200 と一緒にリリースされ、同じバージョン番号を持ちます。セルフホストの Status200 では、コマンドがサーバーのレコードと一致するように、お使いの Status200 と同じバージョンの CLI をインストールしてください。
npm install -g @status200/cli@<your-oneuptime-version>最初のコマンドを実行する
API キーを保存する
キーと Status200 のアドレスでログインします。CLI はこれらを
defaultという名前のコンテキストとして保存し、以降はそれを使います。status200 login <your-api-key> https://status200.ruLogged in successfully. Context "default" is now active.と応答します。セルフホストの Status200 では、https://status200.ruの代わりにそのアドレスを使ってください。インシデントを一覧表示する
status200 incident list最新の 10 件のインシデントが表として表示されます。
loginはキーを確認せずに保存するため、キーが動作することを最初に示すのはこのコマンドです。拒否された場合はトラブルシューティングを参照してください。ほかに何を管理できるかを確認する
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 | コマンドのヘルプを表示します |
ヘルプを表示する
すべてのコマンドに、引数、オプション、既定値を示す独自のヘルプがあります。
status200 --help
status200 help incident
status200 incident list --help