API Monitoring の Management API の使用

API Monitoring の管理 API を使用して、次のタスクを行います。

タスク 詳細情報
API Monitoring のアラートを管理する
API Monitoring のコレクションを管理する
API Monitoring ログをさまざまなレベルで表示する
API Monitoring 指標を表示する

curl を使用する

このドキュメントの API の例では、API Monitoring で API を使用する方法を示すために、curl を使用します。オープンソースのコマンドライン ツールである curl では、URL 構文を使用してデータを転送でき、HTTP や HTTPS などの一般的なプロトコルをサポートしています。curl のダウンロード方法と使い方については、https://curl.haxx.se/ をご覧ください。

次の表に、このドキュメントの例で使用している curl コマンドライン オプションの概要を示します。

オプション 説明
-d '{}'

--data @filename

リクエスト本文を定義します。本文は直接渡すことも、ファイル名を指定することもできます。
-H

--header

リクエスト ヘッダーを定義します。リクエスト ヘッダーには次の情報を渡す必要があります。
  • ユーザー認証に使用する OAuth 2.0 トークンAuthorization ヘッダーを使用します。詳しくは、OAuth 2.0 アクセス トークンを取得するをご覧ください。
  • クライアントでサポートされるコンテンツ タイプAccept ヘッダーを使用します。
  • リソース(POSTPATCHPUT)の作成または更新で送信するリクエスト本文のコンテンツ タイプContent-Type ヘッダーを使用します。
-i ヘッダーなど、レスポンスに含まれる詳細情報を表示します。
-X リクエストの種類(GETPOST など)を指定します。

OAuth 2.0 アクセス トークンを取得する

Apigee Edge は、ユーザー認証で OAuth 2.0 をサポートしています。OAuth 2.0 を使用すると、アクセス トークンとリフレッシュ トークンの Apigee Edge 認証情報を交換し、これらの情報を使用して Apigee Edge API を安全に呼び出します。トークンを取得した場合、トークンが期限切れになるまで認証情報を交換する必要はありません。リフレッシュ トークンを使用すると、認証情報を入力することなく、サーバーとのセッションを長時間維持できます。アクセス トークンの詳細については、OAuth2 を使用して管理 API にアクセスするをご覧ください。

Apigee Edge の認証情報を使用すると、OAuth 2.0 アクセス トークンとリフレッシュ トークンを取得し、Apigee の get_token ユーティリティを使用して Apigee Edge のリリースにアクセスできます。

OAuth 2.0 アクセス トークンを取得するには:

  1. get_token ユーティリティをインストールします。get_token ユーティリティのインストール方法については、get_token の使用をご覧ください。

  2. get_token を実行して、OAuth 2.0 アクセス トークンを取得します。

    コマンドを初めて入力する場合、あるいはリフレッシュ トークンが期限切れの場合、get_token のプロンプトが表示され、ユーザー名、パスワード、6 桁の 2 要素認証プロセスの認証コードを入力するように指示されます。プロンプトが表示されたら、それぞれの値を入力します。2 要素認証プロセスが有効でない場合は、プロンプトで Enter キーを押します。

  3. OAuth 2.0 トークンをコピーして、ACCESS_TOKEN などの変数に保存します。

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg
    
        

API Monitoring API を呼び出すときに、Authorization ヘッダーを使用して HTTP ヘッダーに OAuth 2.0 アクセス トークンを渡します。次に例を示します。

    
    curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
       -H "Authorization: Bearer $ACCESS_TOKEN"
       ...