• ログイン

REST API経由でSyntheticsモニターを管理する

合成REST APIを使用して、ping、シンプルブラウザ、スクリプト化ブラウザ、APIテストモニターなど、すべてのタイプの合成モニターを作成および管理します。REST APIを介して、すべての合成モニタリングデータを入手できます。

合成REST APIを使用するには、その機能とユーザーキーを使用できるユーザーロールが必要です。

入手可能なすべてのAPIの概要については、API入門を参照してください。

重要

NerdGraph APIを使用して、合成モニター(証明書チェックモニター、ステップモニター、破損リンクモニターを含む)を管理できるようになりました。

機能

合成モニタリングAPI(v3)の最新バージョンには、以下の機能が追加されました。

合成モニタリングAPI(v3)

機能

POSTリクエストとPUTリクエストのオプションフィールド

SIMPLEBROWSERタイプのモニターのオプションは、UIで使用する場合と同じ要領で指定できます。

PATCHリクエスト

PUT内のモニターエンティティ全体を指定する代わりに、変更するモニターのフィールドのみを更新できます。また、適切なタイプのモニターを使用していることを前提に、OPTIONを指定することもできます。

400 Bad Request件のエラーを含む詳細

合成モニタリングAPI v3以降では、検証エラーが発生すると、できるだけ多くの情報が表示されます。これで、リクエストの問題点を特定しやすくなります。以前のAPIバージョンでは、最初にエラーが発生した時点で検証が中断されていましたが、このAPIではすべての検証が実行され、検証に失敗したすべてのエラーが表示されます。

ページ付け

大きなAPIレスポンスには、適切なページ番号付けが施されます。

NRQLクエリを使用して、APIを介して実行した過去の変更を分析することもできます。

APIにおけるモニタータイプ

以下に、モニターのタイプとAPIにおける名称を示します。

モニターのタイプ

API名

Ping

SIMPLE

シンプルブラウザ

BROWSER

スクリプト化ブラウザ

SCRIPT_BROWSER

APIテスト

SCRIPT_API

APIの使用

合成モニタリングREST APIを使用するには、合成モニターの管理およびユーザーキーの使用が可能である必要があります(REST APIキーは動作しません)。

このAPIは、すべての合成モニターで使用できます。(また、スクリプト化ブラウザ用の追加のAPIメソッドとAPIテストモニターを使用して、これらのモニターに関連付けられたスクリプトを更新することもできます。)このAPIを介して、すべての合成モニタリングデータを入手できます。APIの例には、cURLコマンドが表示されます。

米国ベースのアカウントの場合、次のエンドポイントを使用します:

https://synthetics.newrelic.com/synthetics/api

EUベースのアカウントの場合、次のエンドポイントを使用します:

https://synthetics.eu.newrelic.com/synthetics/api

注意

合成モニタリングREST APIでは、アカウントのリクエスト速度が1秒あたり3つのリクエストに制限されます。この閾値を超えて行われたリクエストは、429レスポンスコードを返します。

スクリプト化ブラウザとAPIテストモニター用のスクリプトAPI

汎用APIに加えて、スクリプト化ブラウザ (SCRIPT_BROWSER) とAPIテストブラウザ (SCRIPT_API) 用のAPIメソッドがいくつかあります。以下に、cURLコマンドの例を示します。

スクリプト化ブラウザの例

New RelicのREST APIとbashスクリプトを使用して、スクリプト化されたブラウザモニターを作成する例を示します。

Copyright © 2022 New Relic株式会社。

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.