API出力におけるページ送り

パフォーマンス上の理由により、New Relic REST API (v2) は、レスポンスの出力をページ区切りにします。 (セット全体を返すことは少数のアカウントでは問題ないかもしれません。しかし、非常に大規模なアカウントがあることを考慮して、禁止しています。)

注: 現状では、REST API エクスプローラーは、出力に複数ページがあることを示していません。しかし、表示しているページ簡単に変更できます。

目次

API呼び出しから返されたリンクヘッダにはページ数が含まれています。New Relicは、
RFC 5988で定義されたリンクに関する標準フォーマット使用しています。

API 出力は以下の様なLinkの行を含んでいます。

Link: <https://api.newrelic.com/v2/alert_policies.xml?page=2>;rel="next", 
<https://api.newrelic.com/v2/alert_policies.xml?page=3>;rel="last"

上記は、全部で3ページあり、現在は1ページ目を表示していることを示しています。

パラメーター 説明
…page=2>;rel=”next” 次のページは2ページ目です。
…page=3>;rel=”last” 最後のページは3ページ目です。

特定ページのリクエスト

ページを指定するには、クエリにpage=パラメーターを追加します。以下の例は、15ページ目を要求しています。

curl -X GET 'https://api.newrelic.com/v2/applications/
${APP_ID}/metrics.xml?page=15' \ -H 'X-Api-Key:${API_KEY}' -i 

(${API_KEY}${APP_ID}は、適切な値に置き換えてください。)

さらに詳しい情報

追加のドキュメントは以下のとおりです。

  • API Explorerの利用 (New Relicに対してデータの入出力を行うNew RelicのREST API V2のUIの概要について)
  • API Explorerの部品 (API Explorerの各セクションの使い方についてのクイックリファレンス)