認証

CLI が送るすべてのリクエストには、プロジェクトの API キーが付きます。status200 login でキーを一度保存する(環境ごとに 1 つのコンテキスト)か、スクリプトのようにフラグや環境変数でコマンドに渡します。このページでは、それぞれの方法と、複数ある場合にコマンドがどれを使うかを説明します。

はじめる前に#

プロジェクトの API キーが必要です。プロジェクト設定 → 詳細 → API キー で API キーを作成 から作成し、コマンドに必要なアクセスを与えてください。API キーを作成するを参照してください。キーは権限で許されたことを行います。レコードの読み取りだけが許されたキーは、一覧表示と読み取りはできますが、変更はできません。

Status200 Cloud では、API キーはプロジェクトが Growth プラン以上の間だけ動作します。それ未満では、プロジェクトがアップグレードされるまで、すべてのコマンドがプランを示すメッセージとともに API error (402) を返します。アップグレードすれば同じキーが再び動作します。プラン未満の API キーと SCIMを参照してください。

ログインする#

status200 login は API キーと Status200 のアドレスをコンテキストとして保存し、現在のコンテキストにします。

status200 login <api-key> <instance-url> [--context-name <name>]

たとえば production という名前のコンテキストの場合:

status200 login <api-key> https://status200.ru --context-name production

Logged in successfully. Context "production" is now active. と応答します。アドレス末尾のスラッシュは取り除かれ、同じ名前でもう一度ログインするとそのコンテキストが置き換わります。

コンテキスト#

コンテキストとは保存したログインのことで、名前、アドレス、API キーからなります。プロジェクトや環境ごとに 1 つ保存し、その後のすべてのコマンド、または 1 つのコマンドのために 1 つを選びます。

1. 環境ごとにコンテキストを保存する#

   Bash

   status200 login <production-api-key> https://status200.ru --context-name production
   status200 login <staging-api-key> https://status200.example.com --context-name staging

   ログインするたびにそのコンテキストが現在のコンテキストになるため、今は staging が現在のコンテキストです。

2. 一覧表示する#

   Bash

   status200 context list

   ┌───┬────────────┬───────────────────────────────┐
   │   │ Name       │ URL                           │
   ├───┼────────────┼───────────────────────────────┤
   │   │ production │ https://status200.ru          │
   ├───┼────────────┼───────────────────────────────┤
   │ * │ staging    │ https://status200.example.com │
   └───┴────────────┴───────────────────────────────┘

   * は現在のコンテキストを示します。API キーが一覧に表示されることはありません。

3. 別のコンテキストに切り替える#

   Bash

   status200 context use production

   Switched to context "production". と応答し、その後のコマンドはこのコンテキストを使います。

4. 1 つのコマンドだけでコンテキストを使う#

   Bash

   status200 incident list --context staging

   現在のコンテキストは変わりません。

コマンドが使う認証情報#

コマンドには API キーと URL が必要です。それぞれを、次の場所のうち値を持つ最初の場所から取得します。

つまり組み合わせることができます。たとえば、API キーを環境変数から、URL を現在のコンテキストから取ることができます。環境変数は、保存したコンテキストを持たないスクリプトや CI ジョブに向いています。

export STATUS200_API_KEY=<api-key>
export STATUS200_URL=https://status200.ru
status200 incident list

export STATUS200_API_KEY=<api-key>
export STATUS200_URL=https://status200.ru
status200 incident list

$env:STATUS200_API_KEY = "<api-key>"
$env:STATUS200_URL = "https://status200.ru"
status200 incident list

1 つのコマンドについては、フラグがほかのすべてより優先されます。

status200 --api-key <api-key> --url https://status200.ru incident list

CLI が使う値を確認する#

status200 whoami は、次のコマンドが使う URL と API キー、およびそれらの取得元のコンテキストを表示します。

status200 whoami

URL:     https://status200.ru
API Key: 4f1c****0a13
Context: production

キーは先頭の 4 文字と末尾の 4 文字だけが表示されます。Context の行は、URL とキーがそのコンテキスト自身の値であり、フラグや環境変数で置き換えられていない場合にだけ表示されます。whoami は Status200 を呼び出さずに設定を読み取ります。表示するのはコマンドが送る内容であり、Status200 がそれを受け入れるかどうかではありません。何も保存も設定もされていない場合は、次のように応答します。

Not authenticated. Run `status200 login` to authenticate.

設定ファイル#

status200 login はコンテキストをホームフォルダーの ~/.oneuptime/config.json (Windows では %USERPROFILE%\.oneuptime\config.json)に保存します。CLI は、自分のユーザーだけが読み書きできるようにこのファイルを作成します(モード 0600)。

{
  "currentContext": "production",
  "contexts": {
    "production": {
      "name": "production",
      "apiUrl": "https://status200.ru",
      "apiKey": "<api-key>"
    },
    "staging": {
      "name": "staging",
      "apiUrl": "https://status200.example.com",
      "apiKey": "<api-key>"
    }
  }
}

このファイルには API キーがそのまま保存されます。共有フォルダー、バックアップ、リポジトリには入れないでください。1 つのコンテキストからログアウトするには status200 context delete <name> で削除し、すべてからログアウトするにはファイルを削除します。漏れたおそれのあるキーは、Status200 の プロジェクト設定 → 詳細 → API キー で削除するまで有効なままです。

出力形式や一覧の件数はここには保存されません。各コマンドに -o と --limit を渡してください。

トラブルシューティング#

次のステップ#