API Explorerの部品

New Relic の REST API Explorer (v2) を最大限に活用するために、ここではユーザーインターフェースの概要を説明します。以下の画像にあるアルファベットの箇所の説明は、それぞれの節となっています。

screen-api-explorer-parts.png
https://rpm.newrelic.com/api/exploreNew RelicのREST API Explorer (v2) には、次のことができるUIがあります。値の検索、API の種類(アプリケーション、サーバー等)の選択、標準コマンド(GET, PUT, DELETE)の利用、パラメーターの要件とレスポンスの表示、API エンドポイントへのテストの実行などができます。

目次

アカウント名

APIキーに関連付く複数のアカウントを持っている場合は、API Explorer のメニューバーのドロップダウンリストから項目を選択します。

関数

選択した種類(New Relic のアプリケーション、サーバー、キートランザクション、プラグインなど)の APIコールにおいて利用可能な関数(GET List、GET Show 等)から任意の関数を選択します。選択した関数は、左側のメニューで影が付きます。選択したパスと API コールを行うための詳細情報がUIに表示されます。以下は例になります。

API Explorer の関数 説明
GET List 選択した種類(アプリケーション、サーバー等)の API コールのすべての名前とIDのリストを表示するには、idは空にしておきます。
GET Show 特定のアプリケーション、サーバー等のデータを表示するには、id を入力してください。
GET Metric Names (リスト) 利用可能なメトリック名のリストを表示するには、idを入力し、name は空のままにしておいてください。
GET Metric Names (説明) 特定のメトリック名の説明を表示するには、idname を入力してください。
GET Metric Data (データ) 選択した種類(アプリケーションなど)の API コールの特定のメトリック詳細を表示するには、idnamevalue を入力してください。
PUT Update 選択した種類(アプリケーションなど)の API コールの既存の値を変更するには、変更対象のIDと変更する値を入力してください。

ヒント: やり直すには、Reset を選択してください。

DELETE アプリやサーバーを削除する前に、データ("health_status": "gray",)がレポートされていないことを確認してください。.

説明

API Explorerは選択した関数へのパス(例えば、Applications > List)と API コールの説明を表示します。

リクエスト

Parameters の値を入力すると、自動的に Request ウィンドウに反映されます。

パラメーター

API Explorer は、選択した API コールやフィルターや場所の種類のような追加情報のパラメータのリストを自動的に表示します。また、パラメーターが必須であるかも表示します。

ここでは入力値が自動的にリクエストウィンドウに反映されます。また、API Explorer で別のページからパラメータ値をコピーして、現在のページに貼り付けることができます。例えば、GET List を使って、サーバーIDを探し、値をコピーし、サーバーの GET Metric Namesid に貼り付けることができます。

パラメータに複数のフィールドがあり、ダイヤモンドicon-api-diamond アイコンがある場合は、以下のオプションを選択できます。

  • 選択範囲を項目の前方、後方に移動するには、アイコンの左または右の箇所を選択します。
  • フィールドの値のアップ(増加)やダウン(減少)するには、上部または下部の箇所を選択します。
  • 時間パラメーターにおいて今日を選択するには、アイコンの正方形の箇所を選択します。

API キー

関数を使うには、API キーが必須です。New Relic にサインインしている場合は、APIキーの値が自動的に入力されます。

ページ

表示したいデータページを選択する。

フォーマット

リクエストで利用するオプションを選択する。例: JSON や XML。

取りうるレスポンスステータス

リクエストに失敗した場合、API Explorer は、API コールのトラブルシューティングに役立つ取りうるステータスコードとその説明を示します。

レスポンスの構造

この色分けされた領域は、パラメータ値やそのフォーマットを含めた、API コールの構造を示しています。

リクエストの送信

APIコールを実行するには、Send Request を押します。エラーレスポンスが表示された場合は、必要な変更を行い、再度選択します。

さらに詳しい情報

追加のドキュメントリソースは次のとおりです。