New Relic AlertsのREST APIコール

New RelicのREST API (v2)を使用すれば、New Relic Alertsを設定できます。APIエクスプローラーには、使用可能なAPIコールごとにcURLリクエストフォーマット、使用可能なパラメーター、潜在的なレスポンス状態コード、JSONレスポンス構造も含まれます。New Relic UIでもアラート条件を作成できます。

New Relic Infrastructureのアラートについては、「New Relic InfrastructureアラートのREST API」を参照してください。

APIで使用可能なデータと機能

使用可能なデータ量は、サブスクリプションレベルデータ保持期間によって異なります。

使用可能な機能は、New Relicアカウントでのロールによって異なります。いくつかの制限が適用されます。

REST API関数 コメント
アカウントデータを表示

一般的に、どのロールもアカウントのREST APIキーGET > List機能を使用して、New Relic Alertsデータを表示できます。アカウントのオーナーとアドミンユーザーは、アドミンユーザーのAPI キーを使用できます。

リストの出力にはページ番号が付けられることに注意してください。出力のページ番号付けの詳細については、API出力のページ番号付けをご覧ください。

使用可能な機能:

アカウントデータのメンテナンス POST > CreatePUT > AddPUT > UpdateDELETEを含むメンテナンス機能を使用するには、アカウントのオーナーまたはアドミンロールおよびアドミンユーザーのAPIキーが必要になります。

REST APIから除外される条件

以下の条件には、APIで使用可能なエンドポイントはありません。

  • APM:ウェブトランザクションのパーセンタイル、条件ターゲティングラベル、ベースライン
  • NRQL:ベースライン

アラートポリシー

これらのAPI関数には、New Relic Alertsのポリシーを簡単に作成、削除、リストすることができるAPIエクスプローラーへのリンクが含まれます。

お使いのアカウントがEUデータセンターでデータをホストする場合は、適切なEUリージョンアカウント向けAPIエンドポイントを使用していることを確認してください。

新しいポリシーを作成する

アドミンまたはオーナー

New Relic Alertsに新しいポリシーを追加するには、アドミンユーザーのAPIキーを使用して、APIコールに以下の2つの値を含めます。

必須の値 定義
インシデントincident_preference

New Relic Alertsがインシデントを作成し、違反をグループ化する方法を決めます。以下のいずれかの方法で行う必要があります。

  • PER_POLICY(デフォルト):ポリシー別のロールアップ。
  • PER_CONDITION条件別のロールアップ。
  • PER_CONDITION_AND_TARGETターゲットと条件ごとにロールアップします。
ポリシーのname(名前) ポリシーのname(名前)は必須です。変更しないままにすると、string(文字列)というポリシーが作成されます。

APIエクスプローラー: Alerts Policies > POST > Create

curl -X POST 'https://api.newrelic.com/v2/alerts_policies.json' \
     -H 'X-Api-Key:{admin_api_key}' -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "policy": {
    "incident_preference": "string",
    "name": "string"
  }
}' 
ポリシーを更新する

アドミンまたはオーナー

このAPIを使用して、既存のポリシーのnameincident_preferenceを更新します。アドミンユーザーのAPIキーが必要になります。

必須の値 定義
id 必須。ポリシーのIDを確認するには、以下のオプションのいずれかを使用します。
  • UIを使用する場合:アラートポリシーのUIページで、URLの2番目の数字がポリシーIDを表します。たとえば、URLがalerts.newrelic.com/accounts/654321/policies/123456の場合、ポリシーIDは123456になります。

  • APIの場合:リストポリシーAPIを使用します。
インシデントincident_preference

New Relic Alertsがインシデントを作成し、違反をグループ化する方法を決めます。以下のいずれかの方法で行う必要があります。

  • PER_POLICY(デフォルト):ポリシー別のロールアップ。
  • PER_CONDITION条件別のロールアップ。
  • PER_CONDITION_AND_TARGETターゲットと条件ごとにロールアップします。
ポリシーのname(名前) ポリシーのname(名前)は必須です。変更しないままにすると、string(文字列)というポリシーが作成されます。List policies APIを使用して、ポリシーの正確な名前を確認します。

APIエクスプローラー: 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"
  }
}' 
既存のポリシーを削除する

アドミンまたはオーナー

New Relic Alertsから既存のポリシーを削除するには、アドミンユーザーのAPIキーを使用し、policy_idを含めます(APIエクスプローラー:から取得可能(Alerts Policies > GET > Listから使用可能)をAPIコールに含めます。

APIエクスプローラー: Alerts Policies > DELETE > Delete

curl -X DELETE 'https://api.newrelic.com/v2/alerts_policies/{policy_id}.json' \
     -H 'X-Api-Key:{admin_api_key}' -i 
既存のポリシーをリストする

アカウントの既存New Relic Alertsポリシーのリストを表示するには、APIキーを使用して以下のオプションの値をAPIコールに含めます。

APIエクスプローラー: Alerts Policies > GET > List

curl -X GET 'https://api.newrelic.com/v2/alerts_policies.json' \
     -H 'X-Api-Key:{api_key}' -i 

通知チャネル

以下のAPI関数には、New Relic Alertsのアラートポリシー用の通知チャネルを簡単に作成、削除、リストアップできるAPIエクスプローラーへのリンクが含まれます。

お使いのアカウントがEUデータセンターでデータをホストする場合は、適切なEUリージョンアカウント向けAPIエンドポイントを使用していることを確認してください。

新しい通知チャネルを作成する

アドミンまたはオーナー

New Relic Alertsに新しい通知チャネルを追加するには、アドミンユーザーのAPIキーを使用して、以下の項目をAPIコールに含めます。

APIエクスプローラーには、通知チャネルのタイプごとに必要な設定値のフォーマットが表示されます。

APIエクスプローラー: Alerts Channels > POST > Create

curl -X POST 'https://api.newrelic.com/v2/alerts_channels.json' \
     -H 'X-Api-Key:{admin_api_key}' -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "channel": {
    "name": "string",
    "type": "string",
    "configuration": "hash"
  }
}'  

この例の"hash"プレースホルダは、適切な値が置換された次のJSONブロックの1つと置き換える必要があります:

電子メールチャネル
{
  "recipients" : "test@google.com",
  "include_json_attachment" : true
}
    
HipChatチャネル
{
  "auth_token": "abc123",
  "room_id": "google.com"
}
OpsGenieチャネル
{
  "api_key": "abc123",
  "teams": "team1",
  "tags": "tag1",
  "recipients": "me@me.com"
}
Slackチャネル
{
  "url": "http://test.com",
  "channel": "channel1"
}
Campfireチャネル
{
  "subdomain": "mysubdomain",
  "token": "123abc",
  "room": "room1"
}
VictorOpsチャネル
{
  "key": "mykey",
  "route_key": "theroute"
}
PagerDutyチャネル
{
  "service_key": "myservicekey"
}
Webhook (json) チャネル

この例は、デフォルトのペイロードが挿入された状態で表示されます(ペイロード属性はオプション)。

ペイロードは、表示されるキーと異なるキーを保持するようにカスタマイズでき、配信の前に$のプレフィックスが付いた属性で補間されて送信されます。

注:condition_idは、condition_family_idを優先して廃止されました。

{
  "base_url": "http://test.com",
  "auth_username": "username",
  "auth_password": "password",
  "payload_type": "application/json",
  "headers": {
    "header1": "test", 
    "header2": "test"
  }
  "payload": {
    "account_id": "$ACCOUNT_ID",
    "account_name": "$ACCOUNT_NAME",
    "closed_violations_count_critical": "$CLOSED_VIOLATIONS_COUNT_CRITICAL",
    "closed_violations_count_warning": "$CLOSED_VIOLATIONS_COUNT_WARNING",
    "condition_family_id": "$CONDITION_FAMILY_ID",
    "condition_id": "$CONDITION_ID",
    "condition_name": "$CONDITION_NAME",
    "current_state": "$EVENT_STATE",
    "details": "$EVENT_DETAILS",
    "duration": "$DURATION",
    "event_type": "$EVENT_TYPE",
    "incident_acknowledge_url": "$INCIDENT_ACKNOWLEDGE_URL",
    "incident_id": "$INCIDENT_ID",
    "incident_url": "$INCIDENT_URL",
    "open_violations_count_critical": "$OPEN_VIOLATIONS_COUNT_CRITICAL",
    "open_violations_count_warning": "$OPEN_VIOLATIONS_COUNT_WARNING",
    "owner": "$EVENT_OWNER",
    "policy_name": "$POLICY_NAME",
    "policy_url": "$POLICY_URL",
    "runbook_url": "$RUNBOOK_URL",
    "severity": "$SEVERITY",
    "targets": "$TARGETS",
    "timestamp": "$TIMESTAMP",
    "violation_callback_url": "$VIOLATION_CALLBACK_URL",
    "violation_chart_url": "$VIOLATION_CHART_URL"
  }
}
Webhook (x-www-form-urlencoded) チャネル

この例は、デフォルトのペイロードが挿入された状態で表示されます(ペイロード属性はオプション)。

ペイロードは、表示されるキーと異なるキーを保持するようにカスタマイズでき、配信の前に$のプレフィックスが付いた属性で補間されて送信されます。

注:condition_idは、condition_family_idを優先して廃止されました。

{
  "base_url": "http://test.com",
  "auth_username": "username",
  "auth_password": "password",
  "payload_type": "application/x-www-form-urlencoded",
  "headers": {
    "header1": "test", 
    "header2": "test"
  },
  "payload": { 
    "account_id": "$ACCOUNT_ID", 
    "account_name": "$ACCOUNT_NAME", 
    "closed_violations_count_critical": "$CLOSED_VIOLATIONS_COUNT_CRITICAL", 
    "closed_violations_count_warning": "$CLOSED_VIOLATIONS_COUNT_WARNING", 
    "condition_family_id": "$CONDITION_FAMILY_ID", 
    "condition_id": "$CONDITION_ID", 
    "condition_name": "$CONDITION_NAME", 
    "current_state": "$EVENT_STATE", 
    "details": "$EVENT_DETAILS", 
    "duration": "$DURATION", 
    "event_type": "$EVENT_TYPE", 
    "incident_acknowledge_url": "$INCIDENT_ACKNOWLEDGE_URL", 
    "incident_id": "$INCIDENT_ID", 
    "incident_url": "$INCIDENT_URL", 
    "open_violations_count_critical": "$OPEN_VIOLATIONS_COUNT_CRITICAL", 
    "open_violations_count_warning": "$OPEN_VIOLATIONS_COUNT_WARNING", 
    "owner": "$EVENT_OWNER", 
    "policy_name": "$POLICY_NAME", 
    "policy_url": "$POLICY_URL", 
    "runbook_url": "$RUNBOOK_URL", 
    "severity": "$SEVERITY", 
    "targets": "$TARGETS", 
    "timestamp": "$TIMESTAMP", 
    "violation_callback_url": "$VIOLATION_CALLBACK_URL", 
    "violation_chart_url": "$VIOLATION_CHART_URL" 
  }
}
既存の通知チャネルを削除する

アドミンまたはオーナー

New Relic Alertsから既存の通知チャネルを削除するには、アドミンユーザーのAPIキーを使用して、channel_idを含めます(APIエクスプローラー:から取得可能(Alerts Channels > GET > List)をAPIコールに含めます。

APIエクスプローラー: Alerts Channels > DELETE > Delete

curl -X DELETE 'https://api.newrelic.com/v2/alerts_channels/{channel_id}.json' \
     -H 'X-Api-Key:{admin_api_key}' -i 
既存の通知チャネルをリストする

アカウントの既存のNew Relic Alerts通知チャネルのリストを表示するには、REST APIキーまたはアドミンユーザーの APIキーと、APIコールのオプションのページ番号付け値を使用します。

APIエクスプローラー: Alerts Channels > GET > List

curl -X GET 'https://api.newrelic.com/v2/alerts_channels.json' \
     -H 'X-Api-Key:{api_key}' -i 
ポリシーに関連する通知チャネルを更新する

アドミンまたはオーナー

New Relic Alertsでは、1つ以上の通知チャネルにポリシーを関連付けることができます。また、通知チャネルを1つ以上のアラートポリシーに関連付けることもできます。この関係を更新するには、アドミンユーザーのAPIキーと、APIコールの以下の値を使用します。

  • policy_id値(APIエクスプローラー:から取得可能Alerts Policies > GET > Listで使用可能)
  • カンマまたは改行で区切られた、配列内の1つ、または複数のchannel_id値(APIエクスプローラー:から取得可能Alerts Channels > GET > Listで使用可能)

APIエクスプローラー: Alerts Policy Channels > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_policy_channels.json' \
     -H 'X-Api-Key:{admin_api_key}' -i \
     -H 'Content-Type: application/json' \
     -G -d 'policy_id=policy_id&channel_ids=channel_id' 
ポリシーに関連する通知チャネルを削除する

アドミンまたはオーナー

New Relic Alertsでは、1つ以上の通知チャネルにポリシーを関連付けることができます。また、通知チャネルを1つ以上のアラートポリシーに関連付けることもできます。チャネルからポリシーを削除するか、またはポリシーからチャネルを削除するには、アドミンユーザーのAPIキーと、APIコールの以下の値を使用します。

APIエクスプローラー: Alerts Policy Channels > DELETE > Delete

curl -X DELETE 'https://api.newrelic.com/v2/alerts_policy_channels.json' \
     -H 'X-Api-Key:{admin_api_key}' -i \
     -d 'channel_id={channel_id}&policy_id={policy_id}'  

APM、Browser、Mobileの条件

以下のAPI関数には、New Relic Alertsのアラートポリシーの条件を簡単に作成、更新、削除、リストできるAPIエクスプローラーへのリンクが含まれます。以下のコールは、以下のタイプのターゲットの条件です。

  • APM:アプリとキートランザクション
  • ブラウザ:アプリとキートランザクション
  • モバイル:モバイルアプリ

例外: 次のAPMの条件は、このAPIエンドポイントからは入手できません

  • 条件ターゲティングラベル(ダイナミックターゲティング)
  • ウェブトランザクションのパーセンタイル条件
  • ベースライン条件

APIエクスプローラーは、外部サービス (APMおよびMobile)、プラグインSyntheticsモニターを含む、別々のエンドポイントを使用して他のタイプの条件に関する情報を提供します。検索または更新中にすべてのタイプのアラート条件を考慮します。お使いのアカウントがEUデータセンターでデータをホストする場合は、適切なEUリージョンアカウント向けAPIエンドポイントを使用していることを確認してください。

ポリシーの条件を作成する

アドミンまたはオーナー

New Relic Alertsのポリシーに条件を追加するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: Alerts Conditions > POST > Create

curl -X POST 'https://api.newrelic.com/v2/alerts_conditions/policies/{policy_id}.json' \
     -H 'X-Api-Key:{admin_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エクスプローラー:から条件idを表示することもできますAlerts Conditions > GET > Listから表示することもできます。

ポリシーの条件を更新する

アドミンまたはオーナー

New Relic Alertsのポリシーの条件を更新するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: Alerts Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_conditions/{id}.json' \
     -H 'X-Api-Key:{admin_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"
    }
  }
}'  
ポリシーから条件を削除する

アドミンまたはオーナー

New Relic Alertsのポリシーから条件を削除するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: Alerts Conditions > DELETE > Delete

curl -X DELETE 'https://api.newrelic.com/v2/alerts_conditions/{condition_id}.json' \
     -H 'X-Api-Key:{admin_api_key}' -i 
ポリシーの既存の条件をリストする

New Relic Alertsのアラートポリシーに対する既存の条件を表示するには、REST APIキーまたはアドミンユーザーのAPI キーと、APIコールの関連policy_idを使用します。

APIエクスプローラー: Alerts Conditions > GET > List

curl -X GET 'https://api.newrelic.com/v2/alerts_conditions.json' \
     -H 'X-Api-Key:{api_key}' -i \
     -d 'policy_id={policy_id}' 

NRQLの条件(Insights)

以下のAPI関数には、New Relic Alertsのアラートポリシーの条件を簡単に作成、更新、削除、リストできるAPIエクスプローラーへのリンクが含まれます。APIコールはターゲットとして NRQLと一緒に使用できます。

例外: NRQLベースラインの条件は、このエンドポイントからは入手できません

お使いのアカウントがEUデータセンターでデータをホストする場合は、適切なEUリージョンアカウント向けAPIエンドポイントを使用していることを確認してください。

ポリシーのNRQL条件を作成する

アドミンまたはオーナー

NRQLデータの集計方法のため、New Relicはnrql[since_value] を3以上に設定して誤検出を防ぐことを推奨します。

APIエクスプローラー: Alerts Nrql Conditions > POST > Create

curl -X POST 'https://api.newrelic.com/v2/alerts_nrql_conditions/policies/{policy_id}.json' \
     -H 'X-Api-Key:{admin_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",
        "since_value": "string"
    }
  }
}' 

Nrql[since_value]3 minutesに設定し、nrql[query]SELECT count FROM myEventに設定する場合、New Relic Alertsは1分間に1回の頻度で、terms[threshold]値に対する次のクエリを評価します:

SELECT count FROM myEvent SINCE 3 minutes ago UNTIL 2 minutes ago

type外れ値と設定すると、value_functionを除外できますが、以下の2つのフィールドを追加する必要があります。expected_groupsおよびignore_overlapです。くわしくは、アラート条件APIフィールド名をご覧ください。

typeを除外するか静的と設定すると、標準的なNRQLアラートにデフォルト設定されます。

ポリシーのNRQL条件を更新する

アドミンまたはオーナー

NRQLデータの集計方法のため、New Relicはnrql[since_value] を3以上に設定して誤検出を防ぐことを推奨します。

New Relic Alertsのポリシーの条件を更新するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: Alerts Nrql Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_nrql_conditions/{id}.json' \
     -H 'X-Api-Key:{admin_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",
        "since_value": "string"
    }
  }
}' 
ポリシーのNRQL条件を削除する

アドミンまたはオーナー

New Relic Alertsのポリシーから条件を削除するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: Alerts Nrql Conditions > DELETE > Delete

curl -X DELETE 'https://api.newrelic.com/v2/alerts_nrql_conditions/{condition_id}.json' \
     -H 'X-Api-Key:{admin_api_key}' -i 
ポリシーの既存のNRQL条件をリストする

New Relic Alertsのアラートポリシーに対する既存の条件を表示するには、REST APIキーまたはアドミンユーザーのAPI キーと、APIコールの関連policy_idを使用します。

APIエクスプローラー: 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関数には、New Relic Alertsのアラートポリシーの条件を簡単に作成、更新、削除、リストできるAPIエクスプローラーへのリンクが含まれます。以下のコールは外部サービスの条件です。APIコールは、ターゲットとしてAPMやモバイルアプリと一緒に使用できます。

お使いのアカウントがEUデータセンターでデータをホストする場合は、適切なEUリージョンアカウント向けAPIエンドポイントを使用していることを確認してください。

外部サービス:ポリシーの条件を作成する

アドミンまたはオーナー

APMターゲットまたはMobilターゲットのあるNew Relic Alertsのポリシーに対して外部サービスの条件を追加するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: 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:{admin_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エクスプローラー:から条件idを表示することもできますAlerts External Service Conditions > GET > List

外部サービス:ポリシーの条件を更新する

アドミンまたはオーナー

APMターゲットまたはMobilターゲットのあるNew Relic Alertsのポリシーに対して外部サービスの条件を更新するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: Alerts External Service Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_external_service_conditions/{id}.json' \
     -H 'X-Api-Key:{admin_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"
      }
    ]
  }
}' 
外部サービス:ポリシーから条件を削除する

アドミンまたはオーナー

New Relic AlertsのAPMターゲットまたはMobileターゲットのあるポリシーから外部サービスの条件を削除するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: 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:{admin_api_key}' -i 
外部サービス:ポリシーの既存の条件をリストする

New Relic Alertsの外部サービスターゲット(APMまたはMobile)を持つポリシーに対する既存の条件を表示するには、REST API キーまたはアドミンユーザーのAPIキーと、APIコールの関連policy_idを使用します。

APIエクスプローラー: 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}' 

Syntheticsの条件

以下のAPI関数には、New Relic Alertsのアラートポリシーの条件を簡単に作成、更新、削除、リストできるAPIエクスプローラーへのリンクが含まれます。APIコールはターゲットとしてSyntheticsモニターと一緒に使用できます。

Synthetics:ポリシーの条件を作成する

アドミンまたはオーナー

SyntheticsモニターをターゲットとするNew Relic Alertsのポリシーに条件を追加するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: Alerts Synthetics Conditions > POST > Create

curl -X POST 'https://api.newrelic.com/v2/alerts_synthetics_conditions/policies/{policy_id}.json' \
     -H 'X-Api-Key:{admin_api_key}' -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "synthetics_condition": {
    "name": "string",
    "monitor_id": "string",
    "runbook_url": "string",
    "enabled": "boolean"
  }
}' 
 

JSONレスポンスは、条件の更新や削除に必要な条件idを返します。APIエクスプローラー:から条件idを表示することもできますAlerts Synthetics Conditions > GET > List

Synthetics:ポリシーの条件を更新する

アドミンまたはオーナー

SyntheticsモニターをターゲットとするNew Relic Alertsのポリシーの条件を更新するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: Alerts Synthetics Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_synthetics_conditions/{id}.json' \
     -H 'X-Api-Key:{admin_api_key}' -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "synthetics_condition": {
    "name": "string",
    "monitor_id": "string",
    "runbook_url": "string",
    "enabled": "boolean"
  }
}' 
Synthetics:ポリシーから条件を削除する

アドミンまたはオーナー

New Relic AlertsのSyntheticsターゲットのあるポリシーから条件を削除するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: Alerts Synthetics Conditions > DELETE > Delete

curl -X DELETE 'https://api.newrelic.com/v2/alerts_synthetics_conditions/{condition_id}.json' \
     -H 'X-Api-Key:{admin_api_key}' -i 
Synthetics:ポリシーの既存の条件をリストする

New Relic AlertsのSyntheticsターゲットを持つポリシーに対する既存の条件を表示するには、REST APIキーまたはアドミンユーザーのAPIキーと、APIコールの関連policy_idを使用します。

APIエクスプローラー: 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関数には、New Relic Alertsのアラートポリシーの条件を簡単に作成、更新、削除、リストできるAPIエクスプローラーへのリンクが含まれます。APIコールはNew Relicのプラグインセントラルのプラグインと一緒にターゲットとして使用できます。

プラグイン:ポリシーの条件を作成する

アドミンまたはオーナー

プラグインのコンポーネントまたはインスタンスをターゲットとするNew Relic Alertsのポリシーに条件を追加するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: Alerts Plugins Conditions > POST > Create

curl -X POST 'https://api.newrelic.com/v2/alerts_plugins_conditions/policies/{policy_id}.json' \
     -H 'X-Api-Key:{admin_api_key}' -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "plugins_condition": {
    "name": "string",
    "enabled": "boolean",
    "entities": [
      "integer"
    ],
    "metric_description": "string",
    "metric": "string",
    "value_function": "string",
    "runbook_url": "string",
    "terms": [
      {
        "duration": "string",
        "operator": "string",
        "priority": "string",
        "threshold": "string",
        "time_function": "string"
      }
    ],
    "plugin": {
      "id": "string",
      "guid": "string"
    }
  }
}' 

JSONレスポンスは、条件の更新や削除に必要な条件idを返します。APIエクスプローラー:から条件idを表示することもできますAlerts Plugins Conditions > GET > List

プラグイン:ポリシーの条件を更新する

アドミンまたはオーナー

プラグインのコンポーネントまたはインスタンスをターゲットとするNew Relic Alertsのポリシーの条件を更新するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: Alerts Plugins Conditions > PUT > Update

curl -X PUT 'https://api.newrelic.com/v2/alerts_plugins_conditions/{id}.json' \
     -H 'X-Api-Key:{admin_api_key}' -i \
     -H 'Content-Type: application/json' \
     -d \
'{
  "plugins_condition": {
    "name": "string",
    "enabled": "boolean",
    "entities": [
      "integer"
    ],
    "metric_description": "string",
    "metric": "string",
    "value_function": "string",
    "runbook_url": "string",
    "terms": [
      {
        "duration": "string",
        "operator": "string",
        "priority": "string",
        "threshold": "string",
        "time_function": "string"
      }
    ],
    "plugin": {
      "id": "string",
      "guid": "string"
    }
  }
}'  
プラグイン:ポリシーから条件を削除する

アドミンまたはオーナー

プラグインコンポーネントまたはインスタンスをターゲットとするNew Relic Alertsのポリシーから条件を削除するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: Alerts Plugins Conditions > DELETE > Delete

curl -X DELETE 'https://api.newrelic.com/v2/alerts_plugins_conditions/{condition_id}.json' \
     -H 'X-Api-Key:{admin_api_key}' -i 
プラグイン:ポリシーの既存の条件をリストする

New Relic Alertsのターゲットとしてプラグインコンポーネントまたはインスタンスを持つポリシーに対する既存の条件を表示するには、REST APIキーまたはアドミンユーザーのAPI キーと、APIコールの関連policy_idを使用します。

APIエクスプローラー: Alerts Plugins Conditions > GET > List

curl -X GET 'https://api.newrelic.com/v2/alerts_plugins_conditions.json' \
     -H 'X-Api-Key:{api_key}' -i \
     -d 'policy_id={policy_id}' 

アラートのアクティビティ:イベント、違反、インシデント

以下のAPI関数には、New Relic Alertsのアラートポリシーのイベント、違反、インシデントに関する情報を簡単に表示できるAPIエクスプローラーへのリンクが含まれます。

お使いのアカウントがEUデータセンターでデータをホストする場合は、適切なEUリージョンアカウント向けAPIエンドポイントを使用していることを確認してください。

イベント

New Relic APM、ブラウザ、Mobile、プラグイン、Synthetics、Alertsが監視するエンティティイベントを表示するには、以下の項目を API 呼び出しに含めます。

APIエクスプローラー: アラートイベント > GET > リスト

curl -X GET 'https://api.newrelic.com/v2/alerts_events.json' \
     -H 'X-Api-Key:{api_key}' -i 
違反

アカウントのNew Relic Alertsが監視するエンティティ違反を表示するには、以下の項目をAPI呼び出しに含めます。

APIエクスプローラー: Alerts Violations > GET > List

curl -X GET 'https://api.newrelic.com/v2/alerts_violations.json' \
     -H 'X-Api-Key:{api_key}' -i 

ポリシー、条件、インシデントの情報を検索するには:violationsプロパティのlinksセクションにあるIDを取得し、それらをペイロードの外部linksプロパティに含まれるURLに配置します。

インシデント

アカウントのNew Relic Alertsが監視するエンティティインシデントを表示するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: アラートインシデント > GET > リスト

curl -X GET 'https://api.newrelic.com/v2/alerts_incidents.json' \
     -H 'X-Api-Key:{api_key}' -i 

アラートエンティティ条件

以下のAPI関数には、New Relic Alertsのアラートポリシーに対する条件のエンティティを簡単にリスト、追加、削除できるAPIエクスプローラーへのリンクが含まれます。

お使いのアカウントがEUデータセンターでデータをホストする場合は、適切なEUリージョンアカウント向けAPIエンドポイントを使用していることを確認してください。

エンティティ別に条件をリストする

New Relic APM、Browser、Mobile、キートランザクション、プラグインの場合、エンティティが一部となるアラート条件を表示するには、以下の項目をAPIコールに含めます。

APIエクスプローラー: 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コールに含めます。

  • アドミンユーザーのAPIキー
  • entity_idは、監視されることになるエンティティ(アラートターゲット)です。New Relic APMアプリケーション、ブラウザアプリ、プラグイン、キートランザクション、モバイルアプリの数値IDです。
  • condition_idAPIエクスプローラー:から取得可能Alerts Conditions > GET > List
  • entity_typeは、次のいずれかである必要があります(Syntheticsには使用不可):
    • アプリケーション
    • ブラウザアプリケーション
    • モバイルアプリケーション
    • キートランザクション
    • プラグイン

APIエクスプローラー: 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コールに含めます。

  • アドミンユーザーのAPIキー
  • entity_idは、削除されることになる特定の監視対象エンティティ(アラートターゲット)です。APMアプリケーション、ブラウザアプリ、プラグイン、キートランザクション、モバイルアプリの数値IDです。
  • condition_idAPIエクスプローラー:から取得可能Alerts Conditions > GET > List
  • entity_typeは、次のいずれかである必要があります(Syntheticsには使用不可):
    • アプリケーション
    • ブラウザアプリケーション
    • モバイルアプリケーション
    • キートランザクション
    • プラグイン

APIエクスプローラー: 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_type}&condition_id={condition_id}' 

その他のヘルプ

推奨する詳細情報: