アラートについてのREST APIコール

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

Infrastructureのアラートについては、InfrastructureモニタリングアラートのREST APIを参照してください。

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

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

一般的に、どのロールもアカウントのREST APIキーまたは個人用 APIキーGET > List機能を使用して、アラートデータを表示できます。アカウントの所有者 (オーナー)と管理者は、自身のAPI キーを使用できます。

リストの出力にはページ番号が付けられることに注意してください。使用可能な機能:

アカウントデータのメンテナンス POST > CreatePUT > AddPUT > UpdateDELETEを含むメンテナンス機能を使用するには、アカウントのオーナーまたはアドミンロールおよびアドミンユーザーのAPIキーを使用するかまたはアラートを管理するためのアクセス許可を付与するカスタムロールおよびパーソナル APIキーが必要になります。

REST APIから除外される条件

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

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

パーソナル APIキーと REST API を使用する

以下に示すいずれかの例でパーソナル APIキーを使用するには、'X-Api-Key: {api_key} ' を 'Api-Key: {personal_api_key} ' に置き換えます。

アラートポリシー

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

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

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

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

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

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キーまたはパーソナル APIキーが必要になります。

必須の値 定義
id 必須。ポリシーのIDを確認するには、以下のオプションのいずれかを使用します。
  • UIを使用する場合:ポリシーのUIページで、ポリシー名の下にあるIDを検索します。

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

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

  • PER_POLICY(デフォルト):ポリシー別のロールアップ。
  • PER_CONDITION条件別のロールアップ。
  • PER_CONDITION_AND_TARGETターゲットと条件ごとにロールアップします。
ポリシーの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"
  }
}' 
既存のポリシーを削除する

既存のポリシーを削除するには、アドミンユーザーのAPIキーまたはパーソナル 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 
既存のポリシーをリストする

アカウントの既存ポリシーのリストを表示するには、APIキーまたはパーソナル 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関数には、Alertsの通知チャネルを作成、削除、リストアップできるAPIエクスプローラーへのリンクが含まれます。

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

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

新しい通知チャネルを追加するには、アドミンユーザーのAPIキーパーソナル 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
}
    
OpsGenieチャネル
{
  "api_key": "abc123",
  "teams": "team1",
  "tags": "tag1",
  "recipients": "me@me.com"
}
Slackチャネル
{
  "url": "http://test.com",
  "channel": "channel1"
}
VictorOpsチャネル
{
  "key": "mykey",
  "route_key": "theroute"
}
PagerDutyチャネル
{
  "service_key": "myservicekey"
}
Webhook (json) チャネル

この例では、デフォルトのpayloadを挿入しています。(payload属性は任意です。)

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

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)チャネル

この例では、デフォルトのpayloadを挿入しています。(payload属性は任意です。)

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

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" 
  }
}
既存の通知チャネルを削除する

既存の通知チャネルを削除するには、アドミンユーザーのAPIキーまたはパーソナル APIキーを使用して、channel_idAPIエクスプローラー:から取得可能)を含めます。(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 
既存の通知チャネルをリストする

アカウントの既存の通知チャネルのリストを表示するには、REST APIキー、アドミンユーザーの 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 Relics Alertsでは、1つ以上の通知チャネルにポリシーを関連付けることができます。また、通知チャネルを1つ以上のポリシーに関連付けることもできます。ポリシーに通知チャネルを追加するには、アドミンユーザーのAPIキーまたはパーソナル 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 Relics Alertsでは、1つ以上の通知チャネルにポリシーを関連付けることができます。また、通知チャネルを1つ以上のアラートポリシーに関連付けることもできます。

チャネルからポリシーを削除するか、またはポリシーからチャネルを削除するには、アドミンユーザーのAPIキーまたはパーソナル 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関数には、ポリシーの条件を簡単に作成、更新、削除、リストできるAPIエクスプローラーへのリンクが含まれます。こうしたコールは、以下のタイプのエンティティ向け条件となります:

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

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

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

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

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

ポリシーに条件を追加するには、以下の値を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から表示することもできます。

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

ポリシーの条件を更新するには、以下の値を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"
    }
  }
}'  
ポリシーから条件を削除する

ポリシーから条件を削除するには、以下の値を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 
ポリシーの既存の条件をリストする

ご利用のポリシーに対する既存条件の一覧を表示するには、REST APIキーまたはアドミンユーザーの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の条件

このAPI関数には、ポリシーのNRQL条件を簡単に作成、更新、削除、リストできるAPIエクスプローラーへのリンクが含まれます。

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

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

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

推奨事項:NRQLデータの集計方法上、nrql[since_value]3以上に設定して誤検出を防いでください。これは、Alerts Condition UIの評価オフセット値と同じです。

APIエクスプローラー: 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:{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に、またnrql[query]SELECT count FROM myEventに設定する場合、New Relicは1分間に1回の頻度でterms[threshold]値に対する次のクエリを評価します:

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

typeoutlierとして設定すると、value_functionを省略できます。ただし、次の2つの追加フィールドが必須となります:expected_groupsおよびignore_overlapです。詳細に付いては、アラート条件APIフィールド名をご覧ください。

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

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

推奨事項:NRQLデータの集計方法上、nrql[since_value]3以上に設定して誤検出を防いでください。これよって、3分間のデータ集計が可能となり、Alerts Condition UIの評価オフセット値と同じになります。

ポリシーのNRQL条件を更新するには、以下の値を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条件を削除する

ポリシーからNRQL条件を削除するには、以下の値を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条件をリストする

ご利用のアラートポリシーに対する既存条件の一覧を表示するには、REST APIキー、アドミンユーザーの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関数には、ポリシーの条件を簡単に作成、更新、削除、リストできるAPIエクスプローラーへのリンクが含まれます。以下のコールは外部サービスの条件です。APIコールは、APMやMobileアプリと共に使用できます。

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

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

APMまたはMobileアプリを有するポリシーの外部サービスに条件を追加するには、以下の値を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またはMobileアプリを有するポリシーの外部サービスの条件を更新するには、以下の値を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"
      }
    ]
  }
}' 
外部サービス:ポリシーから条件を削除する

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 
外部サービス:ポリシーの既存の条件をリストする

外部サービスアプリ(APMまたはMobile)でポリシーの既存条件の一覧を表示するには、REST API キー、アドミンユーザーの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}' 

Syntheticモニタリングの条件

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

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

Syntheticsモニタリングのポリシーに条件を追加するには、以下の値を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モニタリングのポリシーの条件を更新するには、以下の値を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モニタリングのポリシーの条件を削除するには、以下の値を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モニタリングの既存のポリシー条件の一覧を表示するには、REST APIキー、アドミンユーザーの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関数には、アラートポリシーの条件を簡単に作成、更新、削除、リストできるAPIエクスプローラーへのリンクが含まれます。APIコールは、New Relicのプラグインセントラルのプラグインと共に使用できます。

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

プラグインのコンポーネントまたはインスタンスのポリシーに条件を追加するには、以下の値を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

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

プラグインのコンポーネントまたはインスタンスのポリシーの条件を更新するには、以下の値を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"
    }
  }
}'  
プラグイン:ポリシーから条件を削除する

プラグインのコンポーネントまたはインスタンスのポリシーから条件を削除するには、以下の値を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 
プラグイン:ポリシーの既存の条件をリストする

プラグインコンポーネントまたはインスタンスで、ポリシーに対する既存の条件を表示するには、REST APIキー、アドミンユーザーの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関数には、アラートポリシーのイベント、違反、インシデントに関する情報を表示できるAPIエクスプローラーへのリンクが含まれます。

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

イベントのリスト

APM、Browser、Mobile、Plugins、Syntheticsモニタリング、Alertsが監視するエンティティイベントを表示するには、以下の値をAPI コールに含めます:

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

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

アカウントについて監視するエンティティ違反を表示するには、以下の値を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に配置します。

インシデントのリスト

アカウントについて監視するエンティティインシデントを表示するには、以下の値をAPIコールに含めます:

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

curl -X GET 'https://api.newrelic.com/v2/alerts_incidents.json' \
     -H 'X-Api-Key:{api_key}' -i 
インシデントの表示

アカウントに関連付けられた単一のインシデントを表示するには、以下の値をAPIコールに含めます:

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

curl -X GET 'https://api.newrelic.com/v2/alerts_incidents/{id}.json' \
     -H 'X-Api-Key:{api_key}' -i 
インシデントの認識

アカウントに関連付けられたインシデントを認識するには、以下の値をAPIコールに含めます:

APIエクスプローラー: アラートインシデント > PUT > 認識

curl -X PUT 'https://api.newrelic.com/v2/alerts_incidents/{id}/acknowledge.json' \
     -H 'X-Api-Key:{api_key}' -i \
     -H 'Content-Type: application/json' 
インシデントのクローズ

アカウントに関連付けられたインシデントをクローズするには、以下の値をAPIコールに含めます:

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

curl -X PUT 'https://api.newrelic.com/v2/alerts_incidents/{id}/close.json' \
     -H 'X-Api-Key:{api_key}' -i \
     -H 'Content-Type: application/json'

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

こうしたAPI関数には、アラートポリシーに対する条件のエンティティをリスト、追加、削除できるAPIエクスプローラーへのリンクが含まれます。

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

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

APM、Browser、Mobile、キートランザクション、Pluginsにおいて、エンティティが一部となる条件を表示するには、以下の値を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エクスプローラー: 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エクスプローラー: 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}' 

その他のヘルプ

さらに支援が必要な場合は、これらのサポートと学習リソースを確認してください: