当社のREST APIは、New RelicのオリジナルAPIで、New Relicのアラート設定をプログラムで設定します(当社の優先APIであるNerdGraphの詳細をご覧ください)。
REST APIエクスプローラーには、使用可能なAPIコールごとにcurl
リクエストフォーマット、使用可能なパラメーター、取りうるレスポンス状態コード、JSONレスポンス構造も含まれます。UIでもアラート条件を作成できます。
REST APIを使用する前に
REST APIを使用してアラートデータを管理する前に、 のAPIの概要をお読みください。
インフラストラクチャのアラートについては、[REST API for infrastructure monitoring alerts](/docs/infrastructure/new-relic-infrastructure/infrastructure-alert-conditions/)を参照してください。
REST APIで使用可能なデータと機能
REST API functions | Comments |
---|---|
アカウントデータを表示 | 一般に、どのロールでも、またはGET > List関数を使用可能なREST APIキーを使用してアラートデータをview閲覧することができます。アカウントの所有者と管理者は、自身のAPIキーを使用できます。 リストの出力にはページ番号が付けられることに注意してください。使用可能な機能:
|
アカウントデータのメンテナンス | POST > Create、PUT > Add、PUT > Update、DELETEを含む任意のメンテナンス機能を使用するには、アカウントの所有者または管理者ロールandおよびユーザーキーを使用するか、orまたはアラートを管理するためのアクセス許可を付与するカスタムロールandおよびユーザーキーが必要になります |
REST APIから除外される条件
以下の条件には、APIで使用可能なエンドポイントはありません。
- APM:ウェブトランザクションパーセンタイル、条件ターゲティングラベル、異常
- NRQL:異常
アラートポリシー
これらのAPI関数には、ポリシーを簡単に作成、削除、リストすることができるAPIエクスプローラーへのリンクが含まれます。
重要
お客様の組織がEUデータセンターでデータをホストする場合は、適切なEU地域アカウント向けAPIエンドポイントを使用していることを確認してください。
新しいポリシーを追加するには、ユーザーキーを使用して、APIコールに以下の2つの値を含めます。
Required values | Definition |
---|---|
インシデント | アラートがインシデントを作成する方法を決めます。以下のいずれかの方法で行う必要があります。 |
ポリシー |
API Explorer > Alerts Policies > POST > Create
curl -X POST 'https://api.newrelic.com/v2/alerts_policies.json' \
-H "X-Api-Key:$API_KEY" -i \
-H 'Content-Type: application/json' \
-d \
'{
"policy": {
"incident_preference": "string",
"name": "string"
}
}'
このAPIを使用して、既存のポリシーのname
とincident_preference
を更新します。ユーザーキーが必要になります。
Required values | Definition |
---|---|
| 必須。ポリシーのIDを確認するには、以下のオプションのいずれかを使用します。
|
インシデント | アラートがインシデントを作成する方法を決めます。以下のいずれかの方法で行う必要があります。 |
Required. 名前を変更しない場合は、stringというポリシーにデフォルト設定されます。 List policies APIを使用して、ポリシーの正確な名前を確認します。 |
API Explorer > Alerts Policies > PUT > Update
curl -X PUT 'https://api.newrelic.com/v2/alerts_policies/{id}.json' \
-H "X-Api-Key:$API_KEY" -i \
-H 'Content-Type: application/json' \
-d \
'{
"policy": {
"incident_preference": "string",
"name": "string"
}
}'
既存のポリシーを削除するには、ユーザーキーを使用して、policy_id
(API Explorer > Alerts Policies > GET > Listから入手可能)をAPIコールに含めます。
API Explorer > Alerts Policies > DELETE > Delete
curl -X DELETE 'https://api.newrelic.com/v2/alerts_policies/$POLICY_ID.json' \
-H "X-Api-Key:$API_KEY" -i
アカウントの既存ポリシーのリストを表示するには、ユーザーキーを使用して以下のオプションの値をAPIコールに含めます。
オプションのポリシー
name
フィルターオプションのページ番号付けの値
API Explorer > Alerts Policies > GET > List
curl -X GET 'https://api.newrelic.com/v2/alerts_policies.json' \ -H "X-Api-Key:$API_KEY" -i
APM、ブラウザ、モバイルの条件
このAPI関数には、ポリシーの条件を簡単に作成、更新、削除、リストできるAPIエクスプローラーへのリンクが含まれます。こうしたコールは、以下のタイプのエンティティ向け条件となります:
- APM:アプリとキートランザクション
- Browser:アプリとキートランザクション
- Mobile:モバイルアプリ
Exception: 次のAPMの条件は、このAPIエンドポイントからはnot available取得できません。
- 条件ターゲティングラベル(ダイナミックターゲティング)
- ウェブトランザクションのパーセンタイル条件
- 異常条件
重要
APIエクスプローラーは、外部サービス(APMおよびモバイル)や外形監視など、separate endpoints個別のエンドポイントを使用して他のタイプの条件に関する情報を提供します。検索または更新中にすべてのタイプのアラート条件を考慮します。アカウントがEUデータセンターでデータをホストする場合は、適切なEUリージョンアカウント向けAPIエンドポイントを使用していることを確認してください。
ポリシーに条件を追加するには、以下の値をAPIコールに含めます:
ご利用の
policy_id
(API Explorer > Alerts Policies > GET > Listから入手可能)APIコールで必須とされる
condition
値(APIエクスプローラーページとアラート条件のAPI用語集で説明されています)API Explorer > Alerts Conditions > POST > Create
curl -X POST 'https://api.newrelic.com/v2/alerts_conditions/policies/$POLICY_ID.json' \ -H "X-Api-Key:$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
を返します。条件id
はAPI Explorer > Alerts Conditions > GET > Listからも表示できます。
ポリシーの条件を更新するには、以下の値をAPIコールに含めます:
条件
id
(API Explorer > Alerts Conditions > GET > Listから入手可能)APIコールで必須とされる
condition
値(APIエクスプローラーページとアラート条件のAPI用語集で説明されています)API Explorer > Alerts Conditions > PUT > Update
curl -X PUT 'https://api.newrelic.com/v2/alerts_conditions/$CONDITION_ID.json' \ -H "X-Api-Key:$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
curl -X DELETE 'https://api.newrelic.com/v2/alerts_conditions/$CONDITION_ID.json' \ -H "X-Api-Key:$API_KEY" -i
ご利用のポリシーについて既存条件の一覧を表示するには、REST APIキーまたはユーザーキー、および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 "X-Api-Key:$API_KEY" -i
NRQLの条件
このAPI関数には、ポリシーのNRQL条件を簡単に作成、更新、削除、リストできるAPIエクスプローラーへのリンクが含まれます。
Exception: NRQL異常の条件は、このエンドポイントからはnot available入手できません。
重要
お客様の組織がEUデータセンターでデータをホストする場合は、適切なEU地域アカウント向けAPIエンドポイントを使用していることを確認してください。
推奨事項:NRQLデータのストリーミング方法に応じて、aggregation_method
をEVENT_FLOW
に設定し、aggregation_window
には60
、aggregation_delay
には120
のデフォルト設定を使用します。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 "X-Api-Key:$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エクスプローラー Alerts NRQL Conditions > GET > Listから入手可能)APIコールで必須とされる
condition
値(APIエクスプローラーページとアラート条件のAPI用語集で説明されています)API Explorer > Alerts NRQL Conditions > PUT > Update
curl -X PUT 'https://api.newrelic.com/v2/alerts_nrql_conditions/$CONDITION_ID.json' \ -H "X-Api-Key:$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エクスプローラー Alerts NRQL Conditions > GET > Listから入手可能)API Explorer > Alerts NRQL Conditions > DELETE > Delete
curl -X DELETE 'https://api.newrelic.com/v2/alerts_nrql_conditions/$CONDITION_ID.json' \ -H "X-Api-Key:$API_KEY" -i
ご利用のアラートポリシーについて既存条件の一覧を表示するには、REST APIキー、およびAPIコールの関連policy_id
を使用します。
API Explorer > Alerts NRQL Conditions > GET > List
curl -X GET 'https://api.newrelic.com/v2/alerts_nrql_conditions.json' \
-H "X-Api-Key:$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
curl -X POST 'https://api.newrelic.com/v2/alerts_external_service_conditions/policies/$POLICY_ID.json' \ -H "X-Api-Key:$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
を返します。条件id
はAPI Explorer > Alerts External Service Conditions > GET > Listからも表示できます。
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
curl -X PUT 'https://api.newrelic.com/v2/alerts_external_service_conditions/$CONDITION_ID.json' \ -H "X-Api-Key:$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 > Delete
curl -X DELETE 'https://api.newrelic.com/v2/alerts_external_service_conditions/$CONDITION_ID.json' \ -H "X-Api-Key:$API_KEY" -i
外部サービスアプリ(APMまたはモバイルモニタリング)を持つポリシーの既存条件の一覧を表示するには、ユーザーキーまたはREST APIキー、および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 "X-Api-Key:$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
curl -X POST 'https://api.newrelic.com/v2/alerts_synthetics_conditions/policies/$POLICY_ID.json' \ -H "X-Api-Key:$API_KEY" -i \ -H 'Content-Type: application/json' \ -d \ '{ "synthetics_condition": { "name": "string", "monitor_id": "string", "runbook_url": "string", "enabled": boolean } }'
JSONレスポンスは、条件の更新や削除に必要な条件
id
を返します。条件id
はAPI Explorer > Alerts Synthetics Conditions > GET > Listからも表示できます。
合成モニタリングのポリシーの条件を更新するには、以下の値をAPIコールに含めます:
条件
id
(API Explorer > Alerts Synthetics Conditions > GET > Listから入手可能)APIコールで必須とされる
synthetics_condition
値(synthetics用のアラート条件の作成のためのAPIエクスプローラーページとアラート条件のAPI用語集で説明されています)API Explorer > Alerts Synthetics Conditions > PUT > Update
curl -X PUT 'https://api.newrelic.com/v2/alerts_synthetics_conditions/$CONDITION_ID.json' \ -H "X-Api-Key:$API_KEY" -i \ -H 'Content-Type: application/json' \ -d \ '{ "synthetics_condition": { "name": "string", "monitor_id": "string", "runbook_url": "string", "enabled": boolean } }'
合成モニタリングのポリシーの条件を削除するには、以下の値をAPIコールに含めます:
condition_id
(API Explorer > Alerts Synthetics Conditions > GET > Listから入手可能)API Explorer > Alerts Synthetics Conditions > DELETE > Delete
curl -X DELETE 'https://api.newrelic.com/v2/alerts_synthetics_conditions/$CONDITION_ID.json' \ -H "X-Api-Key:$API_KEY" -i
合成モニタリングの既存のポリシー条件一覧を表示するには、ユーザーキーまたはREST APIキー、およびAPIコールの関連policy_id
を使用します。
API Explorer > Alerts Synthetics Conditions > GET > List
curl -X GET 'https://api.newrelic.com/v2/alerts_synthetics_conditions.json' \
-H "X-Api-Key:$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
curl -X POST 'https://api.newrelic.com/v2/alerts_location_failure_conditions/policies/$POLICY_ID.json' \ -H "X-Api-Key:$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
を返します。条件id
はAPI Explorer > Alerts Location Failure Conditions > GET > Listからも表示できます。
複数の場所における合成モニタリングのポリシーの条件を更新するには、以下の値をAPIコールに含めます:
条件
id
(API Explorer > Alerts Location Failure Conditions > GET > Listから入手可能)APIコールで必須とされる
location_failure_condition
値(APIエクスプローラーページとアラート条件のAPI用語集で説明されています)API Explorer > Alerts Location Failure Conditions > PUT > Update
curl -X PUT 'https://api.newrelic.com/v2/alerts_location_failure_conditions/$CONDITION_ID.json' \ -H "X-Api-Key:$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 > Delete
curl -X DELETE 'https://api.newrelic.com/v2/alerts_location_failure_conditions/$CONDITION_ID.json' \ -H "X-Api-Key:$API_KEY" -i
複数の場所における合成モニタリングの既存のポリシー条件一覧を表示するには、ユーザーキーまたはREST APIキー、および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 "X-Api-Key:$API_KEY" -i
アラートエンティティ条件
こうしたAPI関数には、アラートポリシーに対する条件のエンティティをリスト、追加、削除できるAPIエクスプローラーへのリンクが含まれます。
重要
お客様の組織がEUデータセンターでデータをホストする場合は、適切なEU地域アカウント向けAPIエンドポイントを使用していることを確認してください。
APM、ブラウザ、モバイル、キートランザクションにおいて、エンティティに適用される条件を表示するには、以下の値をAPIコールに含めます:
entity_id
は監視対象の特定のエンティティ(アラートターゲット)です。entity_type
は、次のいずれかである必要があります:- アプリケーション
- ブラウザアプリケーション
- モバイルアプリケーション
- キートランザクション
API Explorer > Alerts Entity Conditions > GET > list
curl -X GET 'https://api.newrelic.com/v2/alerts_entity_conditions/$ENTITY_ID.json' \ -H "X-Api-Key:$API_KEY" -i \ -G -d 'entity_type=$ENTITY_TYPE'
条件にエンティティを追加するには、以下の値をAPIコールに含めます:
entity_id
は監視対象のエンティティ(アラートターゲット)です。APMアプリケーション、ブラウザアプリ、キートランザクション、モバイルアプリの数値IDです。condition_id
(API Explorer > Alerts Conditions > GET > Listから入手可能)entity_type
は、次のいずれかである必要があります:- アプリケーション
- ブラウザアプリケーション
- モバイルアプリケーション
- キートランザクション
API Explorer > Alerts Entity Conditions > PUT > Add
curl -X PUT 'https://api.newrelic.com/v2/alerts_entity_conditions/$ENTITY_ID.json' \ -H "X-Api-Key:$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
は、次のいずれかである必要があります:- アプリケーション
- ブラウザアプリケーション
- モバイルアプリケーション
- キートランザクション
API Explorer > Alerts Entity Conditions > DELETE > Remove
curl -X DELETE 'https://api.newrelic.com/v2/alerts_entity_conditions/$ENTITY_ID.json' \ -H "X-Api-Key:$API_KEY" -i \ -G -d 'entity_type=$ENTITY_ID&condition_id=$CONDITION_ID'