합성 REST API 버전 1(더 이상 사용되지 않음)

현재 뉴렐릭은 신세틱 모니터링 API v1과 v3의 두 가지 버전을 지원합니다. 버전 3은 2016년 10월에 출시되었습니다. Version 1 is deprecated 은(는) 결국 더 이상 사용할 수 없게 됩니다. 종료 날짜는 발표되지 않았습니다. 그러나 v1에 대한 추가 개발이나 수정은 이루어지지 않습니다.

주의

권장 사항: v3 합성 API 를 사용하여 새 모니터를 만들고 v1 스크립트를 v3 스크립트로 마이그레이션하십시오.

New Relic의 종합 모니터링에 REST API를 사용하려면 API 액세스를 활성화하고 계정 설정에서 Admin User의 API 키를 생성해야 합니다. 그런 다음 명령줄을 통해 표준 API 호출을 수행할 수 있습니다.

단순 및 스크립트 모니터 관리

합성 REST API를 호출하려면 관리자의 API 키를 사용해야 합니다. 계정의 REST API 키가 작동하지 않습니다.

주의

합성 REST API는 계정의 요청 속도를 초당 3개의 요청으로 제한합니다. 이 임계값을 초과하는 요청은 429 응답 코드를 반환합니다.

다음 예에서는 curl 명령을 보여줍니다.

계정에 대한 New Relic의 모든 모니터 목록을 보려면 https://synthetics.newrelic.com/synthetics/api/v1/monitors 에 GET 요청을 보내십시오. 예를 들어:

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에서 단일 기존 모니터를 보려면 https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id} 에 GET 요청을 보냅니다. 다음 예에서 {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, DISABLED) [required],
  "slaThreshold": double,
}

또한 REST API를 통해 add a scripted monitor 에 추가 API 엔드포인트를 호출하여 방금 생성된 모니터에 대한 스크립트를 보냅니다.

다음 예의 Synthetics REST API 속성 을 특정 값으로 바꿉니다.

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와 함께 201 Created 응답을 반환합니다. 가능한 오류 코드는 다음과 같습니다.

400 Bad Request
: 모니터 값 중 하나 이상이 잘못되었거나 요청 형식이 잘못되었습니다. 예를 들어 빈도가 범위를 벗어났거나 지정된 위치 중 하나 이상이 잘못되었습니다(응답 본문의 오류 메시지 참조).
402 Payment Required
: 모니터를 생성하면 예약된 수표가 계정의 구매 수표 한도를 초과하여 증가합니다.

New Relic에서 기존 모니터를 업데이트하려면 https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id} 에 PUT 요청을 보냅니다. 또한 스크립팅된 모니터의 경우 절차에 따라 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
: 모니터 값 중 하나 이상이 잘못되었거나 요청 형식이 잘못되었습니다. 예를 들어 빈도가 범위를 벗어났거나 지정된 위치 중 하나 이상이 잘못되었습니다(응답 본문의 오류 메시지 참조).
404 Not Found
: 지정한 모니터가 존재하지 않습니다.

New Relic에서 기존 모니터를 삭제하려면 https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id} 에 DELETE 요청을 보냅니다. 다음 예에서 {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 외에도 scripted browser (SCRIPT_BROWSER) 및 api test (SCRIPT_API) 모니터 유형에 대한 여러 API 메서드가 있습니다.

이 예는 curl 명령을 보여줍니다.

계정에 대한 New Relic의 특정 SCRIPT_BROWSER 또는 SCRIPT_API 모니터와 연결된 스크립트를 보려면 https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}/script 에 GET 요청을 보냅니다. {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:
지정된 모니터가 존재하지 않거나 모니터와 연결된 스크립트가 존재하지 않습니다.

계정에 대한 뉴렐릭의 특정 SCRIPT_BROWSER 또는 SCRIPT_API 모니터와 연결된 스크립트를 업데이트하려면 scriptText (필수)이 포함된 JSON 페이로드와 함께 https://synthetics.newrelic.com/synthetics/api/v1/monitors/{id}/script 에 PUT 요청을 보냅니다. scriptLocations 데이터는 Verified Script Execution 설정된 독립 로케이션에만 필요합니다.

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');

이 예에서는 password 을 scriptLocation 의 비밀번호로 사용합니다.

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 Bad Request:
scriptText 또는 hmac 에 대해 잘못된 BASE64 인코딩 문자열입니다.
403 Forbidden:
지정한 모니터가 펼쳐보기 또는 펼쳐보기 유형이 아닙니다.
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 호출에 사용되는 속성이며 알파벳순으로 나열되어 있습니다.

Synthetics API attribute	Definition
`apiVersion`	문자열: 버전 번호입니다.
`emails`	문자열 배열: New Relic의 경고 알림 을 위한 이메일 주소.
`frequency`	정수: 확인 사이의 시간(분) . 유효한 값은 1, 5, 15, 30, 60, 360, 720, 1440입니다.
`id`	특정 합성 모니터의 UUID입니다.
`locations`	문자열 배열: 전체 레이블별 위치 배열입니다 .
`name`	문자열: 모니터의 이름 .
`scriptLocations`	문자열: 검증된 스크립트 실행 을 사용하는 비공개 위치 에 대한 `name` 및 `hmac` 값입니다.
`scriptText`	문자열: 스크립팅된 모니터 용 BASE64로 인코딩된 텍스트입니다.
`slaThreshold`	Double: Synthetics SLA 보고서 값(초).
`status`	문자열: 유효한 값은 `ENABLED` 및 `DISABLED` 입니다.
`type`	문자열: 모니터 유형 . 유효한 값은 다음과 같습니다. `SIMPLE` (핑) `BROWSER` `SCRIPT_BROWSER` `SCRIPT_API`
`uri`	문자열: `SIMPLE` 및 `BROWSER` 모니터 유형 에 대한 URI ; 예: `http://my-site.com` . `SCRIPT_BROWSER` 및 `SCRIPT_API` 의 경우 선택 사항입니다.
`userID`	정수: 특정 사용자 ID입니다.

특정 모니터 끝점

특정 모니터에 대해 REST API를 호출할 때 monitor_uuid 을 엔드포인트의 일부로 포함합니다. monitor_uuid 은 URL의 일부인 GUID입니다. 예를 들어 선택한 합성 모니터 에는 다음 URL이 있습니다.

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

monitor_uuid 은 /monitors/ 다음에 오는 값입니다.

사용자의 편의를 위해 제공되는 기계 번역입니다.

합성 REST API 버전 1(더 이상 사용되지 않음)

주의

단순 및 스크립트 모니터 관리

주의

모든 모니터 가져오기

특정 모니터 가져오기

모니터 만들기

기존 모니터 업데이트

기존 모니터 삭제

유효한 위치 목록 가져오기

스크립팅된 모니터 관리

모니터 스크립트 가져오기

스크립트 모니터 추가

모니터 스크립트 업데이트

스크립팅된 브라우저 예제

스크립팅된 브라우저 API 예제

Bash 스크립트 예제

합성 속성

특정 모니터 끝점

사용자의 편의를 위해 제공되는 기계 번역입니다.

합성 REST API 버전 1(더 이상 사용되지 않음)

주의

단순 및 스크립트 모니터 관리 .css-21sua1{background:none;border:none;width:0;padding:0;}

주의

특정 모니터 가져오기

모니터 만들기

기존 모니터 업데이트

기존 모니터 삭제

유효한 위치 목록 가져오기

스크립팅된 모니터 관리

모니터 스크립트 가져오기

스크립트 모니터 추가

모니터 스크립트 업데이트

스크립팅된 브라우저 예제

스크립팅된 브라우저 API 예제

Bash 스크립트 예제

합성 속성

특정 모니터 끝점

단순 및 스크립트 모니터 관리