New Relic REST API(v2)の概要

New Relicには、多数のAPIを用意しています。このドキュメントでは、REST APIの概要について説明します。これらの説明を読めば、New Relic製品からデータの取得、GETリクエストを介してデータを抽出、いくつかの設定の追加、および機能の削除を実行できるようになります。

APIエクスプローラーを使用して、 REST APIを介して利用できるデータを理解したり、cURLコマンドを取得したり、JSON応答を表示したりすることもできます。

サブスクリプションレベルに応じて、メトリックタイムスライスのデータにアクセスします。概要データは、無料のNew Relicアカウントで使用可能な唯一のデータです。

動画のチュートリアル

New RelicのREST APIの概要については、この動画をご覧ください。


[動画へのリンク]REST APIの概要に関しては、この動画を視聴してください(約6分)。APIに関する動画とチュートリアルをさらに視聴するには、New Relic APIsの完全オンラインコースに直接アクセスしてください。

セットアップ

所有者(オーナー)または管理者

REST APIを使用するには、アカウント設定からAPIアクセスをアクティブにし、APIキーを生成する必要があります。次に、コマンドライン経由でデータを取得できます。コマンド構造は、このテンプレートに従います。

curl  -X GET <URL> -H "X-api-key:${API_KEY}" -d '<PAYLOAD>'

GETコマンドは、クエリの目的に応じてPOSTまたはDELETEにもなり得ます。

New Relicドキュメントに記載された例では、cURLを共通のコマンドラインツールとして使用し、REST APIからメトリックタイムスライスのデータを引き出します。ただし、RESTリクエストには、あらゆる方法を使用できます。curlコマンドには、すべてのリクエストメカニズムに関連性のあるターゲットURL、ヘッダ情報、およびデータが含まれます。

URL

APIコールには、データにアクセスする場所を指定するURLが必要になります。プレースホルダ<URL>は、リクエストされているデータのタイプに応じて変化する適切なURLに置き換える必要があります。通常、URLはこのテンプレートに従います。

https://api.newrelic.com/v2/applications/${APPID}/metrics/data.json

${APPID}は、データがリクエストされているアプリケーションまたは製品そのものを指定します。このパラメーターに続く情報は、リクエストするデータに応じて異なります。

EUリージョンのアカウントがある場合は、次のURLになります:

api.eu.newrelic.com/v2/applications/${APPID}/metrics/data.json

.json.xmlに置き換えることで、JSONの代わりにXMLデータを取得できます。

APIキー${API_KEY}

New Relic APIコールでは、コールヘッダーにAPIキーが必要になります。APIキーは独自の方法でアカウントを識別し、アカウントデータへのアクセスを承認します。New Relicは、Unixシェルプログラミングからプレースホルダ${API_KEY}を借用しています。${API_KEY}は、必ずNew RelicアカウントからのAPIキーに置き換えてください。

クエリの詳細(ペイロード)

<PAYLOAD>には、次を定義するクエリの詳細が含まれています:

  • クエリするメトリック名および取得する値
  • メトリックスを取得するために定義された時間範囲
  • (オプション):概要で使用するメトリックタイムスライスの平均

APIの使用事例については、次のドキュメントを参照してください。

  • APMの例(New Relic APMのメトリックタイムスライスを取得する方法)
  • ブラウザの例(New Relic Browserのメトリックタイムスライスを取得する方法)
  • ラベルの例(アプリ用のラベルとカテゴリに関する情報を取得する方法)
  • プラグインの例(New Relicプラグインセントラルからプラグインに関する情報とメトリックタイムスライスデータを取得する方法)

アラート送信については、適切なアラート送信システムのドキュメントを参照してください。

その他のヘルプ

推奨する詳細情報: