Synthetics REST API version 1 (deprecated)

現在、New Relicは、v1とv3の2つのバージョンの合成モニタリングAPIをサポートしています。バージョン3は2016年10月にリリースされました。バージョン1は廃止され、最終的には利用できなくなります。終了日は発表されていません。ただし、v1に対してこれ以上の開発や変更は行われません。

注意

推奨事項： v3合成APIを使用して新しいモニターを作成し、v1スクリプトを同等のv3に移行します。

New Relic のシンセティックモニタリングの REST API を使用するには、 API アクセスを有効にして、アカウント設定から Admin User's API key を生成する必要があります。その後、コマンドラインで標準的なAPIコールを行うことができます。

シンプルでスクリプトのあるモニターの管理

合成RESTAPI呼び出しを行うには、管理者ユーザーのAPIキーを使用する必要があります。アカウントのRESTAPIキーは機能しません。

注意

合成RESTAPIは、アカウントのリクエストのレートを1秒あたり3リクエストに制限します。このしきい値を超えて行われたリクエストは、429応答コードを返します。

これらの例は、curlコマンドを示しています。

アカウントのNewRelicにあるすべてのモニターのリストを表示するには、GETリクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/monitorsに送信します。例えば：

curl -v \
     -H 'X-Api-Key:{Admin_User_Key}' https://synthetics.newrelic.com/synthetics/api/v1/monitors

リクエストが成功すると、 200 OK レスポンスが返されます。返されるデータは、以下の形式の JSON オブジェクトとなります。

{
  "count": integer,
  "monitors": [
    {
      "id": UUID,
      "name": string,
      "type": string,
      "frequency": integer,
      "uri": string,
      "locations": array of strings,
      "status": string,
      "slaThreshold": double,
      "userId": integer,
      "apiVersion": string
    }
  ]
}

New Relic で単一の既存のモニターを表示するには、GET リクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}に送信します。次の例の {id} を特定のモニター ID に置き換えます。

curl -v \
     -H 'X-Api-Key:{Admin_User_Key}' https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}

リクエストが成功すると、 200 OK レスポンスが返されます。返されるデータは、以下の形式の JSON オブジェクトとなります。

{
  "id": UUID,
  "name": string,
  "type": string,
  "frequency": integer,
  "uri": string,
  "locations": array of strings,
  "status": string,
  "slaThreshold": double,
  "userId": integer,
  "apiVersion": string
}

無効なモニターIDの場合は、エラー 404 Not Found: 指定されたモニターは存在しません。

New Relicのアカウントに新しいモニターを追加するには、モニターを説明するJSONペイロードを含むPOSTリクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/monitorsに送信します。

{
  "name": string [required],
  "type": string (SIMPLE, BROWSER, SCRIPT_API, SCRIPT_BROWSER) [required],
  "frequency": integer (minutes) [required, must be one of 1, 5, 10, 15, 30, 60, 360, 720, or 1440],
  "uri": string [required for SIMPLE and BROWSER type],
  "locations": array of strings (send a GET request to https://synthetics.newrelic.com/synthetics/api/v1/locations to get a list of valid locations) [at least one required],
  "status": string (ENABLED, MUTED, DISABLED) [required],  
  "slaThreshold": double, 
}

また、 REST API経由でスクリプト付きモニター を追加するには、追加APIエンドポイントを呼び出して、作成したばかりのモニターのスクリプトを送信します。

以下の例の Synthetics REST API attributes をあなたの特定の値に置き換えてください。

curl -v \
     -X POST -H 'X-Api-Key:{Admin_User_Key}' \
     -H 'Content-Type: application/json' https://synthetics.newrelic.com/synthetics/api/v1/monitors \
     -d '{  "name" : "monitor1",  "frequency" : 15, "uri" : "http://my-uri.com",   "locations" : [ "AWS_US_WEST_1" ],   "type" : "browser"}'

リクエストが成功すると、 locationヘッダーで指定された新しく作成されたモニターのURIを使用して、 201Created応答が返されます。考えられるエラーコードは次のとおりです。

400 Bad Request: モニター値の1つ以上が無効であるか、リクエストのフォーマットが無効です。例えば、周波数が範囲外であるとか、指定した場所の1つ以上が無効であるなどです(応答の本文にあるエラーメッセージを参照してください)。
402 Payment Required: モニターを作成すると、アカウントの購入済み小切手限度額を超えて、予定されている小切手が増えます。

New Relicで既存のモニターを更新するには、PUTリクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}に送信します。さらに、スクリプト化モニターの場合、BASE64でエンコードされたスクリプトを更新するの手順に従います。

次の例の {id} を特定のモニター ID に置き換え、 Synthetics REST API 属性を特定の値に置き換えます。

curl -v \
     -X PUT -H 'X-Api-Key:{Admin_User_Key}' \
     -H 'Content-Type: application/json' https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id} \
     -d '{  "name" : "updated monitor name", "type" : "simple", "frequency" : 15, "uri" : "http://my-uri.com/",   "locations" : [ "AWS_US_WEST_1" ],   "status" : "enabled", "slaThreshold": "7.0" }'

PUTリクエストの目的は、ターゲットエンティティを置き換えることにあります。既存のモニターを更新する場合、新しいモニターを作成するときにJSONペイロードで使用する、すべての属性が必要になります。

リクエストが成功すると、空のボディを持つ 204 No Content レスポンスが返されます。可能なエラーコードは以下の通りです。

400 Bad Request: モニター値の1つ以上が無効であるか、リクエストのフォーマットが無効です。例えば、周波数が範囲外であるとか、指定した場所の1つ以上が無効であるなどです(応答の本文にあるエラーメッセージを参照してください)。
404 Not Found: 指定されたモニターは存在しません。

New Relic の既存の監視を削除するには、DELETE リクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}に送信します。次の例の{id}を特定のモニター ID に置き換えます。

curl -v \
     -H 'X-Api-Key:{Admin_User_Key}' \
     -X DELETE https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}

リクエストが成功すると、 204 No Content レスポンスが、空のボディで返されます。リクエストに失敗した場合は、 404 Not Found: 指定されたモニターは存在しませんというレスポンスを返します。

New Relic で有効なロケーションのリストを取得するには、次のコマンドを使用します。

curl -v \
     -X GET -H 'X-Api-Key:{Admin_User_Key}' https://synthetics.newrelic.com/synthetics/api/v1/locations

スクリプトによるモニターの管理

一般的なAPIに加えて、スクリプトブラウザー（ SCRIPT_BROWSER ）およびAPIテスト（ SCRIPT_API ）モニタータイプ用のいくつかのAPIメソッドがあります。

これらの例は、curlコマンドを示しています。

アカウントの New Relic で特定のSCRIPT_BROWSERまたはSCRIPT_APIモニターに関連付けられたスクリプトを表示するには、GET リクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}/scriptに送信します。{id} を特定のモニター ID に置き換えます。例えば：

curl -v
     -H 'X-Api-Key: {Admin_User_Key}' 
     https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}/script

リクエストが成功すると、 200 OK レスポンスが返されます。返されるデータは、以下の形式のJSONオブジェクトです。

{
  "scriptText": BASE64 encoded string
}

可能なエラーコード：

403 Forbidden: 指定されたモニターは SCRIPT_BROWSER または SCRIPT_API のタイプではありません。
404 Not Found: 指定したモニターが存在しないか、そのモニターに関連するスクリプトが存在しない。

REST APIを使ってNew Relicに新しいスクリプトモニターを追加するには。

標準のAPI手順に従って新しいモニターを追加し、 typeをSCRIPT_BROWSERまたはSCRIPT_APIとして識別します。
${MONITOR_UUID}/scriptエンドポイントに対するスクリプトのBASE64エンコードバージョンで新規モニターを更新します。
詳細については、例を参照してください。

アカウントのNewRelicの特定のSCRIPT_BROWSERまたはSCRIPT_APIモニターに関連付けられたスクリプトを更新するには、 scriptText （必須）を含むJSONペイロードを使用してhttps://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}/scriptにPUTリクエストを送信します。 scriptLocationsデータは、 検証済みスクリプトの実行がオンになっているプライベートな場所にのみ必要です。

HMAC文字列の生成に使用するパスワードは、プライベートロケーションに設定されたパスワードと一致する必要があります。HMAC文字列の生成には、SHA256アルゴリズムを使用します。

{
  "scriptText": BASE64 encoded String,
  "scriptLocations": [
    {
      "name": Location name,
      "hmac" BASE64 encoded String of SHA256 HMAC for location
    }
  ]
}

{id} を特定のモニター ID に置き換えます。スクリプトの例を次に示します。

var assert = require('assert');
assert.equal('1', '1');

この例では、 scriptLocationのパスワードとしてpasswordを使用しています。

curl -v
    -H 'X-Api-Key: '{Admin_User_Key}'
    -H 'content-type: application/json'
    https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}/script
    -d '{ "scriptText": "dmFyIGFzc2VydCA9IHJlcXVpcmUoJ2Fzc2VydCcpOw0KYXNzZXJ0LmVxdWFsKCcxJywgJzEnKTs=","scriptLocations": [ { "name": "my_vse_enabled_location", "hmac": "MjhiNGE4MjVlMDE1N2M4NDQ4MjNjNDFkZDEyYTRjMmUzZDE3NGJlNjU0MWFmOTJlMzNiODExOGU2ZjhkZTY4"} ]}'

リクエストが成功すると、空のボディを持つ 204 No Content レスポンスが返されます。考えられるエラーコードは以下の通りです。

400不正なリクエスト： scriptTextまたはhmacのBASE64エンコード文字列が無効です。
403 Forbidden: 指定されたモニターは SCRIPT_BROWSER または SCRIPT_API のタイプではありません。
404 Not Found: 指定されたモニターは存在しません。

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

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

以下の例では、スクリプトによるブラウザモニタを作成するためのcurlコマンドを示しています。

スクリプトの上部で、特定の値で変数を交換します。

scriptfile変数については、作成するスクリプトのファイル名を特定します。以下に示すのは、この例で使用するためにsample_synth_script.jsとして保存できるサンプルスクリプトです：

var assert = require("assert");
$browser.get("http://example.com").then(function(){ 
  // Check the H1 title matches "Example Domain" 
  return $browser.findElement($driver.By.css("h1")).then(function(element){ 
    return element.getText().then(function(text){ 
      assert.equal("Example Domain", text, "Page H1 title did not match"); 
    }); 
  }); 
}).then(function(){ 
  // Check that the external link matches "http://www.iana.org/domains/example" 
  return $browser.findElement($driver.By.css("div > p > a")).then(function(element){ 
    return element.getAttribute("href").then(function(link){ 
      assert.equal("http://www.iana.org/domains/example", link, "More information link did not match"); 
    }); 
  }); 
});

この例は、 SCRIPTED_BROWSERモニターを作成するbashスクリプトを示しています。

#!/bin/bash

# Admin API key from your account settings
adminAPIKey=''
# Other attributes found at https://docs.newrelic.com/docs/apis/synthetics-rest-api/monitor-examples/attributes-synthetics-rest-api#api-attributes
monitorName='Test API Script'
monitorType='SCRIPT_BROWSER'
frequency=1440
locations='"AWS_US_WEST_1", "AWS_US_EAST_1"'
slaThreshold=7.0
# Location of the file with your script
scriptfile=sample_synth_script.js

# Test that the script file exists (does not validate content)
if [ -e "$scriptfile" ]
then
  script=$(cat "$scriptfile")

  payload="{  \"name\" : \"$monitorName\", \"frequency\" : $frequency,    \"locations\" : [ $locations ],   \"status\" : \"ENABLED\",  \"type\" : \"$monitorType\", \"slaThreshold\" : $slaThreshold, \"uri\":\"\"}"
  echo "Creating monitor"

  # Make cURL call to API and parse response headers to get monitor UUID
  shopt -s extglob # Required to trim whitespace; see below
  while IFS=':' read key value; do
    # trim whitespace in "value"
    value=${value##+([[:space:]])}; value=${value%%+([[:space:]])}
    case "$key" in
        location) LOCATION="$value"
                ;;
        HTTP*) read PROTO STATUS MSG <<< "$key{$value:+:$value}"
                ;;
    esac
  done < <(curl -sS -i  -X POST -H "X-Api-Key:$adminAPIKey" -H 'Content-Type: application/json' https://synthetics.newrelic.com/synthetics/api/v1/monitors -d "$payload")

  # Validate monitor creation & add script unless it failed
  if [ $STATUS = 201 ]; then
    echo "Monitor created, $LOCATION "
    echo "Uploading script"
      # base64 encode script
      encoded=`echo "$script" | base64`
      scriptPayload='{"scriptText":"'$encoded'"}'
        curl -s -X PUT -H "X-Api-Key:$adminAPIKey" -H 'Content-Type: application/json' "$LOCATION/script" -d $scriptPayload
        echo "Script uploaded"
  else
    echo "Monitor creation failed"
  fi

else
  echo "script file not found, not creating monitor"
fi

シンセティック属性

ここでは、SyntheticsのREST APIコールで使用される属性をアルファベット順に並べています。

シンセティックAPI属性	定義
`apiVersion`	文字列です。バージョン番号です。
`emails`	文字列の配列。New Relic でアラート通知を受けるためのメールアドレス。
`frequency`	整数です。チェックの間の分数。有効な値は、1、5、15、30、60、360、720、および1440です。
`id`	特定の合成モニターのUUID。
`locations`	Array of strings: Array of locations by full label.
`name`	文字列です。モニターの名前.
`scriptLocations`	文字列：検証済みスクリプト実行を使用したプライベートロケーションの`name`値と`hmac`値。
`scriptText`	文字列です。 scripted monitors のBASE64エンコードされたテキストです。
`slaThreshold`	倍です。 Synthetics SLA レポートの値、単位は秒。
`status`	文字列：有効な値には、 `ENABLED` 、 `MUTED` 、および`DISABLED`が含まれます。
`type`	文字列：モニターの種類.有効な値は以下の通りです。 `SIMPLE` （ping） `BROWSER` `SCRIPT_BROWSER` `SCRIPT_API`
`uri`	文字列： `SIMPLE`および`BROWSER`モニタータイプのURI;たとえば、 `http://my-site.com` 。 `SCRIPT_BROWSER`および`SCRIPT_API`の場合はオプション。
`userID`	整数。特定のユーザーID。

特定のモニターエンドポイント

特定のモニターに対してRESTAPI呼び出しを行う場合は、エンドポイントの一部としてmonitor_uuidを含めます。 monitor_uuidは、URLの一部であるGUIDです。たとえば、選択した合成モニターのURLは次のとおりです。

https://synthetics.newrelic.com/accounts/nnnn/monitors/ab123-c456d-e78-90123-f45g

monitor_uuidは、 /monitors/に続く値です。

この機械翻訳は参考用に提供されます。

Synthetics REST API version 1 (deprecated)

注意

シンプルでスクリプトのあるモニターの管理

注意

すべてのモニターを取得する

特定のモニターを取得する

モニターを作成する

既存のモニターを更新する

既存のモニターを削除する

有効なロケーションのリストを取得

スクリプトによるモニターの管理

モニターのスクリプトを取得する

スクリプト化モニターを追加する

モニターのスクリプトを更新する

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

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

Bashスクリプトの例

シンセティック属性

特定のモニターエンドポイント

この機械翻訳は参考用に提供されます。

Synthetics REST API version 1 (deprecated)

注意

シンプルでスクリプトのあるモニターの管理 .css-21sua1{background:none;border:none;width:0;padding:0;}

注意

特定のモニターを取得する

モニターを作成する

既存のモニターを更新する

既存のモニターを削除する

有効なロケーションのリストを取得

スクリプトによるモニターの管理

モニターのスクリプトを取得する

スクリプト化モニターを追加する

モニターのスクリプトを更新する

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

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

Bashスクリプトの例

シンセティック属性

特定のモニターエンドポイント

シンプルでスクリプトのあるモニターの管理