API出力のパジネーション

New Relic REST API (v2) は、パフォーマンス上の理由から、一部のレスポンスをページネーションします。これは、データセット全体を返すことが可能なクエリもあれば、非常に大量のデータを返すクエリもあるためです。

要件と制限

• メトリックデータのリターン。

  • 一部のお客様のメトリクス出力で、ページネーションが利用できなくなりました（2020年12月より非推奨）。
  • セルあたり最大3000件の結果を返します。大量の結果を得るためには、アプリケーションIDや他の属性を使ってクエリを絞り込むことをお勧めします。

• 返されたデータのソート順は不確定です。特定の順序を仮定したり、依存したりしないでください。

ページごとに返されるデータは、どのようなデータが要求されているかによって異なります。ページ数は、リストを完成させるために必要なJSONオブジェクトの数によって異なります。

特定のページをリクエストする

ページを指定するには、クエリにpage=パラメータを追加します。次に例を示します。

curl -X GET 'https://api.newrelic.com/v2/alerts_incidents.json?page=3' \
     -H "Api-Key:$API_KEY" -i

REST API Explorerでは、 閲覧しているページを素早く変更することができます 。

ページ数を示すリンクヘッダーの例

データがページ分割されている場合、API 呼び出しはLinkヘッダーを返します。これは、ページ数と閲覧中のページを示します。この行は、REST API エクスプローラーのResponseの上部にも表示されます。

curlの一部の実装を使用してこの行を取得するには、 -vオプションを含める必要がある場合があります。

curl -v -X GET 'https://api.newrelic.com/v2/applications/$APP_ID/...'

New Relic では、リンクに RFC 5988 の標準フォーマットを使用しています。

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"