Instana への認証 REST API

Instana ( REST API )と通信するには、リクエストの認証を行う必要があります。 認証は、許可されたユーザーだけがデータにアクセスし、変更できるようにするために必要である。 Instana API トークン認証をサポートしており、 API へのリクエストを簡単かつ安全に認証する方法を提供します。

API トークン認証

API トークンは、リクエストを認証するための安全な方法です。 各トークンは、特定のユーザーまたはサービスに関連付けられており、そのユーザーまたはサービスに付与されたパーミッションを持っています。 API トークン認証は、サーバー間通信や、ユーザーレベルのアクセスを必要としないアプリケーションに最適です。

API トークンの生成

API トークンを生成するには、以下の手順に従ってください:

  1. Instana アカウントにログインしてください。
  2. Instana のUIにあるナビゲーションメニューから、 [設定 ] > [セキュリティとアクセス ] > [ API トークン] をクリックします。
  3. 「新しい API トークン」 をクリックします。
  4. 後で識別できるように、トークンの名前を入力してください。
  5. トークンの適切な権限を選択します。
  6. 「作成」 をクリックします。

API トークンの使用

API トークンを使用してリクエストを認証するには、 HTTPAuthorization へのリクエストのヘッダーにそのトークンを含めます:

GET /api/application-monitoring/applications HTTP/1.1
Host: https://{tenant}-{unit}.instana.io/api
Authorization: apiToken {api_token}

{api_token}を生成したトークンに、{tenant}{unit}を置き換えます。

ベスト・プラクティス

API のトークン認証を使用する際は、以下のベストプラクティスを参考にしてください:

  • トークンの安全確保: API トークンは安全に保管し、クライアントサイドのコード内で公開したり、公に共有したりしないでください。
  • 環境変数を使用する:アプリケーションをデプロイする際は、トークンをソースコードにハードコーディングするのではなく、環境変数に保存してください。
  • トークンを定期的に更新する:不正アクセスのリスクを最小限に抑えるため、 API トークンを定期的に生成し、古いトークンを無効化してください。

エラー処理

認証に失敗した場合、 InstanaREST API はエラーを返します 401 Unauthorized 。 API トークンが正しく設定されており、必要な権限が与えられていることを確認してください。

次の例は、認証に失敗した際の応答を示しています:

{
  "error": "Unauthorized",
  "message": "Invalid API token"
}