우리의 REST API는 New Relic 경고 설정을 프로그래밍 방식으로 구성하기 위한 New Relic의 원래 API입니다( 우리가 선호하는 API인 NerdGraph에 대해 알아보십시오 ).
REST API 탐색기에는 사용 가능한 각 API 호출에 대한 curl
요청 형식, 사용 가능한 파라미터, 변수, 잠재적 응답 상태 코드 및 JSON 응답 구조도 포함되어 있습니다. UI에서 공지 조건을 생성 할 수도 있습니다.
REST API를 사용하기 전에
REST API를 사용하여 알림 데이터를 관리하기 전에 NerdGraph API에서 알림 사용 소개 문서 를 읽어보세요.
감시 경고에 대해서는 감시 모니터링 알림을 위한 REST API 참조하세요.
REST API를 통해 사용 가능한 데이터 및 기능
REST API functions | Comments |
---|---|
계정 데이터 보기 | 일반적으로 모든 역할은 또는 GET > List 기능이 포함된 REST API 키를 사용하여 알림 데이터를 view 할 수 있습니다. 계정 소유자와 관리자는 API 키를 사용할 수 있습니다. 목록 출력은 페이지가 매겨 집니다. 사용 가능한 기능은 다음과 같습니다.
|
계정 데이터 유지 | 계정에는 |
REST API에서 제외된 조건
이러한 유형의 조건에는 API에서 사용 가능한 엔드포인트가 없습니다.
- APM: 웹 트랜잭션 백분위수, 레이블 및 이상을 대상으로 하는 조건
- NRQL: 이상
경고 정책
이러한 API 기능에는 정책을 생성, 삭제 또는 나열할 수 있는 API 탐색기에 대한 링크가 포함되어 있습니다.
중요
조직이 EU 데이터 센터에서 데이터를 호스팅하는 경우 EU 지역 계정에 대해 적절한 API 끝점을사용하고 있는지 확인하세요.
새 정책을 추가하려면 사용자 키 를 사용하고 API 호출에 다음 두 값을 포함합니다.
Required values | Definition |
---|---|
| 알림이 인시던트 를 생성하는 방법을 결정합니다. 다음 중 하나여야 합니다.
|
정책 |
API Explorer > Alerts Policies > POST > Create
$curl -X POST 'https://api.newrelic.com/v2/alerts_policies.json' \> -H "$API_KEY" -i \> -H 'Content-Type: application/json' \> -d \>'{$ "policy": {$ "incident_preference": "string",$ "name": "string"$ }$}'
이 API를 사용하여 기존 정책의 name
및 incident_preference
을 업데이트합니다. 사용자 키 가 필요합니다.
Required values | Definition |
---|---|
| 정책 ID를 찾으려면 다음 옵션 중 하나를 사용하세요.
|
| 알림이 인시던트 를 생성하는 방법을 결정합니다. 다음 중 하나여야 합니다. |
정책 정책의 정확한 이름을 찾으려면 List Policies API 를 사용하십시오. |
API Explorer > Alerts Policies > PUT > Update
$curl -X PUT 'https://api.newrelic.com/v2/alerts_policies/{id}.json' \> -H "$API_KEY" -i \> -H 'Content-Type: application/json' \> -d \>'{$ "policy": {$ "incident_preference": "string",$ "name": "string"$ }$}'
기존 정책을 삭제하려면 사용자 키를 사용하고 API 호출에 policy_id
( API Explorer > Alerts Policies > GET > List 에서 사용 가능)을 포함합니다.
API Explorer > Alerts Policies > DELETE
$curl -X DELETE 'https://api.newrelic.com/v2/alerts_policies/$POLICY_ID.json' \> -H "$API_KEY" -i
계정에 대한 기존 정책 목록을 보려면 사용자 키 를 사용하고 API 호출에 다음과 같은 선택적 값을 포함합니다.
선택적 정책
name
필터선택적 페이지 매김 값
API Explorer > Alerts Policies > GET > List
bash$curl -X GET 'https://api.newrelic.com/v2/alerts_policies.json' \>-H "$API_KEY" -i
APM, 브라우저, 모바일의 조건
이러한 API 기능에는 정책 조건 을 생성, 업데이트, 삭제 또는 나열할 수 있는 API 탐색기에 대한 링크가 포함됩니다. 이러한 호출은 다음 유형의 엔터티가 있는 조건에 대한 것입니다.
- APM: 앱 및 주요 거래
- 브라우저: 앱 및 주요 거래
- 모바일: 모바일 앱
Exception: 다음 APM 조건은 이 API 엔드포인트의 not available 입니다.
- 조건 타겟팅 라벨(동적 타겟팅)
- 웹 트랜잭션 백분위수 조건
- 이상 조건
중요
API Explorer는 separate endpoints를 사용하여 외부 서비스 (APM 및 모바일) 및 신세틱뷰를 포함한 다른 유형의 조건에 대한 정보를 제공합니다. 검색이나 업데이트 시 모든 유형의 공지사항을 고려하세요. 귀하의 계정이 EU 데이터센터에서 데이터를 호스팅하는 경우 EU 지역 계정에 적합한API 엔드포인트를 사용하고 있는지 확인하세요.
정책에 조건을 추가하려면 API 호출에 다음 값을 포함합니다.
당신의
policy_id
( API Explorer > Alerts Policies > GET > List 에서 사용 가능)API 호출의 필수
condition
값(API 탐색기 페이지 및 경고 조건 API 용어집 에 설명됨)API Explorer > Alerts Conditions > POST > Create
bash$curl -X POST 'https://api.newrelic.com/v2/alerts_conditions/policies/$POLICY_ID.json' \>-H "$API_KEY" -i \>-H 'Content-Type: application/json' \>-d \>'{$"condition": {$"type": "string",$"name": "string",$"enabled": boolean,$"entities": [$integer$],$"metric": "string",$"gc_metric": "string",$"condition_scope": "string",$"violation_close_timer": integer,$"runbook_url": "string",$"terms": [${$"duration": "string",$"operator": "string",$"priority": "string",$"threshold": "string",$"time_function": "string"$}$],$"user_defined": {$"metric": "string",$"value_function": "string"$}$}$}'JSON 응답은 조건을 업데이트하거나 삭제해야 하는
id
조건을 반환합니다. API Explorer > Alerts Conditions > GET > List 에서id
조건을 볼 수도 있습니다.
정책 조건을 업데이트하려면 API 호출에 다음 값을 포함합니다.
조건의
id
( API Explorer > Alerts Conditions > GET > List 에서 사용 가능)API 호출의 필수
condition
값(API 탐색기 페이지 및 경고 조건 API 용어집 에 설명됨)API Explorer > Alerts Conditions > PUT > Update
bash$curl -X PUT 'https://api.newrelic.com/v2/alerts_conditions/$CONDITION_ID.json' \>-H "$API_KEY" -i \>-H 'Content-Type: application/json' \>-d \>'{$"condition": {$"type": "string",$"name": "string",$"enabled": boolean,$"entities": [$integer$],$"metric": "string",$"metric": "string",$"gc_metric": "string",$"condition_scope": "string",$"violation_close_timer": integer,$"runbook_url": "string",$"terms": [${$"duration": "string",$"operator": "string",$"priority": "string",$"threshold": "string",$"time_function": "string"$}$],$"user_defined": {$"metric": "string",$"value_function": "string"$}$}$}'
정책에서 조건을 삭제하려면 API 호출에 다음 값을 포함합니다.
condition_id
( API Explorer > Alerts Conditions > GET > List 에서 사용 가능)API Explorer > Alerts Conditions > DELETE > Delete
bash$curl -X DELETE 'https://api.newrelic.com/v2/alerts_conditions/$CONDITION_ID.json' \>-H "$API_KEY" -i
정책에 대한 기존 조건 목록을 보려면 API 호출에서 REST API 키 또는 사용자 키 및 연결된 policy_id
를 사용하세요.
API Explorer > Alerts Conditions > GET > List
$curl -X GET 'https://api.newrelic.com/v2/alerts_conditions.json?policy_id=$POLICY_ID' \> -H "$API_KEY" -i
NRQL의 조건
이러한 API 기능에는 정책에 대한 NRQL 조건 을 생성, 업데이트, 삭제 또는 나열할 수 있는 API 탐색기에 대한 링크가 포함됩니다.
Exception: NRQL 이상 동작 조건은 이 접점 포인트에서 not available 입니다.
중요
조직이 EU 데이터 센터에서 데이터를 호스팅하는 경우 EU 지역 계정에 적절한 API 끝점을사용하고 있는지 확인하십시오.
권장 사항: NRQL 데이터가 스트리밍되는 방식으로 인해 aggregation_method
을 EVENT_FLOW
로 설정하고 aggregation_window
의 60
의 기본 설정과 120
의 경우 aggregation_delay
의 기본 설정을 사용합니다. EVENT_FLOW
대부분의 사용 사례에서 작동하지만 EVENT_TIMER
과 더 잘 어울리는 사용 사례에 대한 논의는 집계 방법 선택을 참조하세요.
API Explorer > Alerts NRQL Conditions > POST > Create
정책에 대한 NRQL 조건을 생성하려면:
$curl -X POST 'https://api.newrelic.com/v2/alerts_nrql_conditions/policies/$POLICY_ID.json' \> -H "$API_KEY" -i \> -H 'Content-Type: application/json' \> -d \>'{$ "nrql_condition": {$ "type": "string",$ "name": "string",$ "runbook_url": "string",$ "enabled": boolean,$ "terms": [$ {$ "duration": "string",$ "operator": "string",$ "priority": "string",$ "threshold": "string",$ "time_function": "string"$ }$ ],$ "value_function": "string",$ "nrql": {$ "query": "string"$ },$ "signal": {$ "aggregation_window": "string",$ "slide_by": "integer",$ "aggregation_method": "string",$ "aggregation_delay": integer,$ "aggregation_timer": integer,$ "fill_option": "string",$ "fill_value": "string"$ },$ "expiration": {$ "expiration_duration": "string",$ "open_violation_on_expiration": boolean,$ "close_violations_on_expiration": boolean$ }$ }$}'
type
을 생략하거나 static
로 설정하면 기본적으로 표준 NRQL 경고가 설정됩니다.
정책에 대한 NRQL 조건을 업데이트하려면 API 호출에 다음 값을 포함합니다.
조건의
id
(API Explorer 에서 사용 Alerts NRQL Conditions > GET > List 가능) )API 호출의 필수
condition
값(API 탐색기 페이지 및 경고 조건 API 용어집 에 설명됨)API Explorer > Alerts NRQL Conditions > PUT > Update
bash$curl -X PUT 'https://api.newrelic.com/v2/alerts_nrql_conditions/$CONDITION_ID.json' \>-H "$API_KEY" -i \>-H 'Content-Type: application/json' \>-d \>'{$"nrql_condition": {$"name": "string",$"runbook_url": "string",$"enabled": boolean,$"terms": [${$"duration": "string",$"operator": "string",$"priority": "string",$"threshold": "string",$"time_function": "string"$}$],$"value_function": "string",$"nrql": {$"query": "string"$}$}$}'
정책에서 NRQL 조건을 삭제하려면 API 호출에 다음 값을 포함합니다.
조건의
id
(API Explorer 에서 사용 Alerts NRQL Conditions > GET > List 가능) )API Explorer > Alerts NRQL Conditions > DELETE > Delete
bash$curl -X DELETE 'https://api.newrelic.com/v2/alerts_nrql_conditions/$CONDITION_ID.json' \>-H "$API_KEY" -i
알림 정책에 대한 기존 조건 목록을 보려면 API 호출에서 사용자 키 또는 REST API 키 및 연결된 policy_id
를 사용하세요.
[API Explorer]https://api.newrelic.com/docs/#/Alerts%20NRQL%20Conditions/get\_alerts\_nrql\_conditions\_json) > Alerts NRQL Conditions > GET > List
$curl -X GET 'https://api.newrelic.com/v2/alerts_nrql_conditions.json' \> -H "$API_KEY" -i \> -d 'policy_id=$POLICY_ID'
외부 서비스에 대한 조건
이러한 API 기능에는 정책 조건을 생성, 업데이트, 삭제 또는 나열할 수 있는 API 탐색기에 대한 링크가 포함되어 있습니다. 이러한 호출은 외부 서비스에 대한 조건입니다. API 호출은 및 모바일 모니터링 앱과 함께 사용할 수 있습니다.
중요
조직이 EU 데이터 센터에서 데이터를 호스팅하는 경우 EU 지역 계정에 적절한 API 끝점을사용하고 있는지 확인하십시오.
APM 또는 모바일 모니터링 앱이 있는 정책에 외부 서비스에 대한 조건을 추가하려면 API 호출에 다음 값을 포함합니다.
policy_id
( API Explorer > Alerts Policies > GET > List 에서 사용 가능)API 호출의 필수
external_service_condition
값(API 탐색기 페이지 및 경고 조건 API 용어집 에 설명됨)API Explorer > Alerts External Service Conditions > POST > Create
bash$curl -X POST 'https://api.newrelic.com/v2/alerts_external_service_conditions/policies/$POLICY_ID.json' \>-H "$API_KEY" -i \>-H 'Content-Type: application/json' \>-d \>'{$"external_service_condition": {$"type": "string",$"name": "string",$"enabled": boolean,$"entities": [$integer$],$"external_service_url": "string",$"metric": "string",$"runbook_url": "string",$"terms": [${$"duration": "string",$"operator": "string",$"priority": "string",$"threshold": "string",$"time_function": "string"$}$]$}$}'JSON 응답은 조건을 업데이트하거나 삭제해야 하는
id
조건을 반환합니다. API Explorer > Alerts External Service Conditions > GET > List 에서id
조건을 볼 수도 있습니다.
외부 서비스에 대한 조건을 APM 또는 모바일 모니터링 앱이 있는 정책으로 업데이트하려면 API 호출에 다음 값을 포함합니다.
외부 서비스 조건의
id
( API Explorer > Alerts External Service Conditions > GET > List 에서 사용 가능)API 호출의 필수
external_service_condition
값(API 탐색기 페이지 및 경고 조건 API 용어집 에 설명됨)API Explorer > Alerts External Service Conditions > PUT > Update
bash$curl -X PUT 'https://api.newrelic.com/v2/alerts_external_service_conditions/$CONDITION_ID.json' \>-H "$API_KEY" -i \>-H 'Content-Type: application/json' \>-d \>'{$"external_service_condition": {$"type": "string",$"name": "string",$"enabled": boolean,$"entities": [$integer$],$"external_service_url": "string",$"metric": "string",$"runbook_url": "string",$"terms": [${$"duration": "string",$"operator": "string",$"priority": "string",$"threshold": "string",$"time_function": "string"$}$]$}$}'
APM 또는 모바일 모니터링 앱이 있는 정책에서 외부 서비스에 대한 조건을 삭제하려면 API 호출에 다음 값을 포함합니다.
condition_id
( API Explorer > Alerts External Service Conditions > GET > List 에서 사용 가능)API Explorer > Alerts External Service Conditions > DELETE
bash$curl -X DELETE 'https://api.newrelic.com/v2/alerts_external_service_conditions/$CONDITION_ID.json' \>-H "$API_KEY" -i
외부 서비스 앱(APM 또는 모바일 모니터링)이 있는 정책에 대한 기존 조건 목록을 보려면 API 호출에서 사용자 키 또는 REST API 키 및 연결된 policy_id
를 사용하세요.
API Explorer > Alerts External Service Conditions > GET > List
$curl -X GET 'https://api.newrelic.com/v2/alerts_external_service_conditions.json' \> -H "$API_KEY" -i \> -d 'policy_id=$POLICY_ID'
종합 모니터링 조건
이러한 API 기능에는 경고 정책에 대한 조건 을 생성, 업데이트, 삭제 또는 나열할 수 있는 API 탐색기에 대한 링크가 포함됩니다. API 호출은 합성 모니터링과 함께 사용할 수 있습니다.
합성 모니터링을 위한 정책에 조건을 추가하려면 API 호출에 다음 값을 포함합니다.
policy_id
( API Explorer > Alerts Policies > GET > List 에서 사용 가능)API 호출의 필수
synthetics_condition
값(API 탐색기 페이지 및 경고 조건 API 용어집 에 설명됨)API Explorer > Alerts Synthetics Conditions > POST > Create
bash$curl -X POST 'https://api.newrelic.com/v2/alerts_synthetics_conditions/policies/$POLICY_ID.json' \>-H "$API_KEY" -i \>-H 'Content-Type: application/json' \>-d \>'{$"synthetics_condition": {$"name": "string",$"monitor_id": "string",$"runbook_url": "string",$"enabled": boolean$}$}'JSON 응답은 조건을 업데이트하거나 삭제해야 하는
id
조건을 반환합니다. API Explorer > Alerts Synthetics Conditions > GET > List 에서id
조건을 볼 수도 있습니다.
정책 조건을 업데이트하려면 API 호출에 다음 값을 포함합니다.
조건의
id
( API Explorer > Alerts Conditions > GET > List 에서 사용 가능)API 호출의 필수
condition
값(API 탐색기 페이지 및 경고 조건 API 용어집 에 설명됨)API Explorer > Alerts Conditions > PUT > Update
bash$curl -X PUT 'https://api.newrelic.com/v2/alerts_conditions/$CONDITION_ID.json' \>-H "X-Api-Key:$API_KEY" -i \>-H "$API_KEY" -i \>-H 'Content-Type: application/json' \>-d \>'{$"condition": {$"type": "string",$"name": "string",$"enabled": boolean,$"entities": [$integer$],$"metric": "string",$"metric": "string",$"gc_metric": "string",$"condition_scope": "string",$"violation_close_timer": integer,$"runbook_url": "string",$"terms": [${$"duration": "string",$"operator": "string",$"priority": "string",$"threshold": "string",$"time_function": "string"$}$],$"user_defined": {$"metric": "string",$"value_function": "string"$}$}$}'
종합 모니터링에 대한 정책 조건을 삭제하려면 API 호출에 다음 값을 포함합니다.
condition_id
( API Explorer > Alerts Synthetics Conditions > GET > List 에서 사용 가능)API Explorer > Alerts Synthetics Conditions > DELETE
bash$curl -X DELETE 'https://api.newrelic.com/v2/alerts_synthetics_conditions/$CONDITION_ID.json' \>-H "$API_KEY" -i
종합 모니터링을 위한 기존 정책 조건 목록을 보려면 API 호출에서 사용자 키 또는 REST API 키 및 연결된 policy_id
를 사용하세요.
API Explorer > Alerts Synthetics Conditions > GET > List
$curl -X GET 'https://api.newrelic.com/v2/alerts_synthetics_conditions.json' \> -H "$API_KEY" -i \> -d 'policy_id=$POLICY_ID'
종합 모니터링을 위한 다중 위치 조건
이러한 API 기능에는 경고 정책에 대한 조건 을 생성, 업데이트, 삭제 또는 나열할 수 있는 API 탐색기에 대한 링크가 포함됩니다. API 호출은 합성 모니터링을 통해 다중 위치 조건에 사용할 수 있습니다. 조건을 생성하거나 업데이트하기 전에 다중 위치 경고 조건에 대한 규칙을 읽으십시오.
다중 위치 종합 모니터링을 위한 정책에 조건을 추가하려면 API 호출에 다음 값을 포함하십시오.
policy_id
( API Explorer > Alerts Policies > GET > List 에서 사용 가능)API 호출의 필수
location_failure_condition
값(API 탐색기 페이지 및 경고 조건 API 용어집 에 설명됨)API Explorer > Alerts Location Failure Conditions > POST > Create
bash$curl -X POST 'https://api.newrelic.com/v2/alerts_location_failure_conditions/policies/$POLICY_ID.json' \>-H "$API_KEY" -i \>-H 'Content-Type: application/json' \>-d \>'{$"location_failure_condition": {$"name": "string",$"runbook_url": "string",$"enabled": boolean,$"entities":$[$"string"$],$"terms": [${$"priority": "string",$"threshold": integer,$}$],$"violation_time_limit_seconds": integer$}$}'JSON 응답은 조건을 업데이트하거나 삭제해야 하는
id
조건을 반환합니다. API Explorer > Alerts Location Failure Conditions > GET > List 에서id
조건을 볼 수도 있습니다.
다중 위치 종합 모니터링에 대한 정책 조건을 업데이트하려면 API 호출에 다음 값을 포함하십시오.
조건
id
( API Explorer > Alerts Location Failure Conditions > GET > List 에서 사용 가능)API 호출의 필수
location_failure_condition
값(API 탐색기 페이지 및 경고 조건 API 용어집 에 설명됨)API Explorer > Alerts Location Failure Conditions > PUT > Update
bash$curl -X PUT 'https://api.newrelic.com/v2/alerts_location_failure_conditions/$CONDITION_ID.json' \>-H "$API_KEY" -i \>-H 'Content-Type: application/json' \>-d \>'{$"location_failure_condition": {$"name": "string",$"runbook_url": "string",$"enabled": boolean,$"entities":$[$"string"$],$"terms": [${$"priority": "string",$"threshold": integer,$}$],$"violation_time_limit_seconds": integer$}$}'
다중 위치 종합 모니터링에 대한 정책 조건을 삭제하려면 API 호출에 다음 값을 포함하십시오.
condition_id
( API Explorer > Alerts Location Failure Conditions > GET > List 에서 사용 가능)API Explorer > Alerts Location Failure Conditions > DELETE
bash$curl -X DELETE 'https://api.newrelic.com/v2/alerts_location_failure_conditions/$CONDITION_ID.json' \>-H "$API_KEY" -i
다중 위치 종합 모니터링에 대한 기존 정책 조건 목록을 보려면 API 호출에서 사용자 키 또는 REST API 키 및 연결된 policy_id
를 사용합니다.
API Explorer > Alerts Location Failure Conditions > GET > List
$curl -X GET 'https://api.newrelic.com/v2/alerts_location_failure_conditions/policies/$POLICY_ID.json' \> -H "$API_KEY" -i
경보 엔티티 조건
이러한 API 기능에는 경고 정책에 대한 조건에서 엔터티를 나열, 추가 및 제거할 수 있는 API 탐색기에 대한 링크가 포함됩니다.
중요
조직이 EU 데이터 센터에서 데이터를 호스팅하는 경우 EU 지역 계정에 적절한 API 끝점을사용하고 있는지 확인하십시오.
APM, 브라우저, 모바일 또는 키 트랜잭션의 엔터티 에 적용되는 조건 을 보려면 API 호출에 다음 값을 포함합니다.
사용자 키 또는 REST API 키
entity_id
모니터링할 특정 엔터티(경고 대상) 입니다.entity_type
, 다음 중 하나여야 합니다.Application
BrowserApplication
MobileApplication
KeyTransaction
API Explorer > Alerts Entity Conditions > GET > list
bash$curl -X GET 'https://api.newrelic.com/v2/alerts_entity_conditions/$ENTITY_ID.json' \>-H "$API_KEY" -i \>-G -d 'entity_type=$ENTITY_TYPE'
항목 을 조건에 추가하려면 API 호출에 다음 값을 포함합니다.
entity_id
모니터링할 엔티티(경고 대상) 입니다. APM 애플리케이션, 브라우저 앱, 키 트랜잭션 또는 모바일 앱의 숫자 ID입니다.condition_id
( API Explorer > Alerts Conditions > GET > List 에서 사용 가능)entity_type
, 다음 중 하나여야 합니다.Application
BrowserApplication
MobileApplication
KeyTransaction
API Explorer > Alerts Entity Conditions > PUT > Add
bash$curl -X PUT 'https://api.newrelic.com/v2/alerts_entity_conditions/$ENTITY_ID.json' \>-H "$API_KEY" -i \>-H 'Content-Type: application/json' \>-G -d 'entity_type=$ENTITY_TYPE&condition_id=$CONDITION_ID'
조건에서 모니터링 중인 엔터티 를 제거하려면 API 호출에 다음 값을 포함합니다.
entity_id
제거할 특정 모니터링 항목(경고 대상) 입니다. APM 애플리케이션, 브라우저 앱, 키 트랜잭션 또는 모바일 앱의 숫자 ID입니다.condition_id
( API Explorer > Alerts Conditions > GET > List 에서 사용 가능)entity_type
, 다음 중 하나여야 합니다.Application
BrowserApplication
MobileApplication
KeyTransaction
API Explorer > Alerts Entity Conditions > DELETE > Remove
bash$curl -X DELETE 'https://api.newrelic.com/v2/alerts_entity_conditions/$ENTITY_ID.json' \>-H "$API_KEY" -i \>-G -d 'entity_type=$ENTITY_ID&condition_id=$CONDITION_ID'