New Relic の API Explorer のはじめかた

New Relic REST API バージョン2 ( https://rpm.newrelic.com/api/explore にて利用可能) を使って、認証済みのユーザーは以下のことが行えます。

  • 利用可能な API エンドポイントの閲覧
  • UI( API Explorer )上でのAPIの利用

必要な解決策を探したり、自身のソフトウェアに組み込む前に API パラメーターの値をテストするのに使えます。

注: Lite アカウントのサブスクリプションは、アプリケーションとサーバーの要約データのみアクセス可能です。Pro 以上のサブスクリプションレベルでは、メトリックデータ値にアクセスできます。サブスクリプションレベルによって API Explorer にもこのような制限が反映されます。

目次

機能

New Relic の API Explorer にはアカウント専用の UI があります。この UI には、API コールのタイプ (ApplicationsServersUsersなど) の一覧や GET ListGET Metric DataPUT UpdateDelete など、利用可能な機能の一覧があります。

Parameters の値を入力すると、その値は自動的に リクエストに表示されます。リクエストを送信する前に、テストや構文チェックを行うことができます。UI は、必須のフィールド、フィールドの説明、型 (integer、float、Boolean等)や位置(path、queryなど)を示します。

注: 現在、New Relic の API Explorer v2 ではキートランザクションのメトリックデータは提供しません。

screen-api-explorer-menu
https://rpm.newrelic.com/api/explore: New Relic のAPI Explorer は、API エンドポイントに対してテストやリクエストの送信を簡単に行えます。アカウントと API コールの種類(applications、servers、users など)の機能を選択した後、UI は要件を表示し、パラメータ値をテストするためのインタラクティブなフォームを提供します。

バージョン1との違い

以下の情報は、New Relic からのデータ入力と出力に焦点を当てた New Relic REST API バージョン2にのみ適用されます。バージョン2は New Relic の REST API バージョン1 と互換性があります。ただし、以下のように違う点もいくつかあります。

  • データの名前が異なる場合がある。
  • v2 用の CURL コマンドは V1 と異なっている点がある。

注: New Relic のエージェント API は同じものではありません。エージェント API は API Explorer による影響は受けません。

さらに詳しい情報

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

  • API キー (New Relic UI 上における API キーの作成、コピー、再作成について)
  • API Explorer の利用 (New Relic に対してデータの入出力を行う New Relic の REST API V2 の UI の概要について)
  • API Explorer の部品 (API Explorer の各セクションの使い方についてのクイックリファレンス)
  • API 出力のページ送り (複数ページとなるAPI 出力におけるリンクヘッダーの解釈方法について)