アクションの抑制 API

このページでは、イベントに対応するポリシーによってアクションおよびアラートの自動トリガーを一時的に停止できるアクションの抑制 API メソッドについて説明します。API は、メンテナンスアクティビティの実行時、またはコンポーネントのトラブルシューティング時に役立ちます。

警告: 注

JSON ペイロードの構文検証は、アクションの抑制を作成する際に実行されます。

新しいアクションの抑制を作成する

指定された JSON ペイロードを使用して新しいアクションの抑制を作成します。「プロパティの詳細」を参照してください。

リソースURL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action-suppressions

要求/応答の形式

JSON

例

リクエスト

この例では、アプリケーション内の特定の正常性ルールに影響を与えるアクションの抑制を作成します。「例のダウンロード」を参照してください。

JSON 
{
"id": 9,
"name": "TestAS",
"disableAgentReporting": false,
"suppressionScheduleType": "ONE_TIME",
"timezone": "Asia/Kolkata",
"startTime": "2020-08-19T11:43:00",
"endTime": "2020-08-19T12:43:00",
"recurringSchedule": null,
"affects": {
"affectedInfoType": "APPLICATION"
},
"healthRuleScope": null
}
レスポンス
JSON 
{
"id": 9,
"name": "TestAS",
"disableAgentReporting": false,
"suppressionScheduleType": "ONE_TIME",
"timezone": "Asia/Kolkata",
"startTime": "2020-08-19T11:43:00",
"endTime": "2020-08-19T12:43:00",
"recurringSchedule": null,
"affects": {
"affectedInfoType": "APPLICATION"
},
"healthRuleScope": null
}

特定のアプリケーションに対して構成されたアクションの抑制のリストの取得

特定のアプリケーションに構成されているすべてのアクションの抑制を返します。必須フィールドは、アクションの抑制 ID と名前です。設定されたアクションの抑制の timezone、startTime、endTime、および recurringSchedule などの詳細が返されます。「プロパティの詳細」を参照してください。

リソースURL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action-suppressions

応答形式

JSON

応答の例

JSON 
[
{
"id": 11,
"name": "TestAS1",
"timezone": "Asia/Kolkata",
"startTime": "2020-08-19T12:06:00",
"endTime": "2020-08-19T13:06:00"
}
{
"id": 12,
"name": "TestAS2",
"timezone": "Asia/Kolkata",
"startTime": "2020-08-19T12:27:00",
"endTime": "2020-08-19T13:27:00"
}
{
"id": 13,
"name": "TestAS3",
"timezone": "Asia/Kolkata",
"startTime": "2020-08-19T12:08:00",
"endTime": "2020-08-19T13:08:00"
}
]

アクションの抑制の詳細の取得

指定されたアクション抑制 ID のアクション抑制の JSON 表現を返します。「プロパティの詳細」を参照してください。

リソースURL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action-suppressions/{action-suppression-id}

応答形式

JSON

応答の例

JSON 
{
"id": 9,
"name": "TestAS",
"disableAgentReporting": false,
"suppressionScheduleType": "ONE_TIME",
"timezone": "Asia/Kolkata",
"startTime": "2020-08-19T11:43:00",
"endTime": "2020-08-19T12:43:00",
"recurringSchedule": null,
"affects": {
"affectedInfoType": "APPLICATION"
},
"healthRuleScope": null
}

アクションの抑制の更新

指定された JSON ペイロードを使用して既存のアクションの抑制を更新します。「プロパティの詳細」を参照してください。

リソースURL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action-suppressions/{action-suppression-id}

要求/応答の形式

JSON

例

リクエスト
JSON 
{
"id": 9,
"name": "TestAS1",
"disableAgentReporting": false,
"suppressionScheduleType": "ONE_TIME",
"timezone": "Asia/Kolkata",
"startTime": "2020-08-19T12:05:00",
"endTime": "2020-08-19T13:05:00",
"recurringSchedule": null,
"affects": {
"affectedInfoType": "APPLICATION"
},
"healthRuleScope": null
}
レスポンス
JSON 
{
"id": 9,
"name": "TestAS",
"disableAgentReporting": false,
"suppressionScheduleType": "ONE_TIME",
"timezone": "Asia/Kolkata",
"startTime": "2020-08-19T11:43:00",
"endTime": "2020-08-19T12:43:00",
"recurringSchedule": null,
"affects": {
"affectedInfoType": "APPLICATION"
},
"healthRuleScope": null
}

アクションの抑制の削除

指定された ID を使用してアクションの抑制を削除します。「プロパティの詳細」を参照してください。

リソースURL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action-suppressions/{action-suppression-id}

名前によるアクションの抑制の詳細の取得

指定されたアクション抑制名のアクション抑制の JSON 表現を返します。「プロパティの詳細」を参照してください。

リソースURL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/action-suppressions/{action-suppression-id}

注: <<ActionSuppressionName>> を、アクションの抑制に指定した名前に置き換えます。たとえば、 ACTION_SUP_15です。

応答形式

JSON

応答の例

JSON 
{
"id": 9,
"name": "TestAS1",
"timezone": "Asia/Kolkata",
"startTime": "2020-08-19T12:05:00",
"endTime": "2020-08-19T13:05:00",
"recurringSchedule": null
}

応答コード

コード 説明
200 正常に取得されました
201 正常に作成されました
204 正常に削除されました
400 Bad request
401 Unauthorized
403 Forbidden
404 リソースが見つかりません
409 すでに存在します

Property Details

注: アスタリスクの付いたプロパティ名は、ペイロードの必須フィールドです。

アクションの抑制

アクションの抑制のペイロードの詳細。

プロパティ名 タイプ 説明と有効な値
id 整数

これはシステムによって自動生成され、応答で返されます。

これは読み取り専用です

name*

文字列

minLength: 1maxLength: 100

アクションの抑制の名前。
disableAgentReporting

boolean

デフォルト：false

 有効にした場合、範囲内に定義されているエージェントは、指定されたタイムフレーム中にメトリックデータを報告しません。
注: disableAgentReporting を true に設定すると、繰り返しアクションの抑制を定義できません。
suppressionScheduleType

文字列

デフォルト：ONE_TIME

アクションの抑制に使用可能なスケジューリングオプション。

Enums

ONE_TIME

recurring
timezone 文字列

タイムゾーン ID。デフォルトのタイムゾーンはコントローラのタイムゾーンです。
startTime

文字列

形式：yyyy-MM-ddTHH:mm:ss

アクションの抑制が開始される時刻。suppressionScheduleType が [ONE_TIME] に設定されている場合にのみ startTime を指定します。startTime を指定しない場合は、現在の時刻からアクションの抑制が開始されます。予期される形式は、rfc3339 に準拠する yyyy-MM-ddTHH:mm:ss です。
endTime

文字列

形式：yyyy-MM-ddTHH:mm:ss

 進行中のアクションの抑制が終了する時刻。suppressionScheduleType が [ONE_TIME] に設定されている場合にのみ startTime を指定します。指定しない場合、アクションの抑制は現在の時刻から 60 分後に終了します。予期される形式は、rfc3339 に準拠する yyyy-MM-ddTHH:mm:ss です。
recurringSchedule 文字列

アクションの抑制を開始するための定期的なスケジュールの詳細。

プロパティ名 タイプ 説明
scheduleFrequency* 文字列

アクションの抑制を呼び出す頻度。

日次

毎週

MONTHLY_SPECIFIC_DATE

MONTHLY_SPECIFIC_DAY

affects*

アクションの抑制の影響を受けるエンティティについて説明します。たとえば、アプリケーション、ビジネストランザクション、サーバ、データベースなどです。

プロパティ名 タイプ 説明
affectedInfoType * 文字列

影響を受けるエンティティタイプ。

Enums

アプリケーション

BUSINESS_TRANSACTIONS

TIERS_NODES

サーバー

DATABASES

SERVERS_IN_SERVERS_APP
healthRuleScope*

アクションの抑制に適用できる正常性ルールの範囲。

プロパティ名 タイプ 説明
healthRuleScopeType * 文字列

アクションの抑制の影響を受ける正常性ルールのタイプ。

Enums

SPECIFIC_HEALTH_RULES

アクションの抑制のスケジュールタイプ

このプロパティを使用して、1 回限りの、または繰り返し実行されるアクションの抑制をスケジュールします。

プロパティ名 タイプ 説明
ActionsuppressionScheduleType 文字列
Enums

ONE_TIME

recurring
1 回限りのアクションの抑制の例
JSON 
{
"name": "Action Suppression With One Time Schedule",
"disableAgentReporting": false,
"suppressionScheduleType": "ONE_TIME",
"timezone": "Asia/Kolkata",
"startTime": "2020-06-18T13:33:37",
"endTime": "2021-06-30T16:48:37",
"recurringSchedule": null,
"affects": {
"affectedInfoType": "APPLICATION"
},
"healthRuleScope": null
}

スケジュールを繰り返す頻度の詳細

このプロパティを使用して、定期的にアクションの抑制を呼び出す頻度を定義します。

プロパティ名 タイプ 説明
scheduleFrequency * 文字列

アクションの抑制を呼び出す頻度について説明します。

Enums

日次

毎週

MONTHLY_SPECIFIC_DATE

MONTHLY_SPECIFIC_DAY
日次でスケジュールされている繰り返しアクションの抑制の例
JSON 
{
"name": "Action Suppression With Daily Schedule",
"disableAgentReporting": false,
"suppressionScheduleType": "RECURRING",
"timezone": "Asia/Kolkata",
"startTime": null,
"endTime": null,
"recurringSchedule": {
"scheduleFrequency": "DAILY",
"startTime": "01:00",
"endTime": "01:22"
},
"affects": {
"affectedInfoType": "APPLICATION"
},
"healthRuleScope": null
}

日次スケジュール：設定の詳細

次のプロパティを使用して、日次でスケジュールされるアクションの抑制の詳細を設定します。

プロパティ名 タイプ 説明
scheduleFrequency * 文字列

アクションの抑制が毎日呼び出されます。

列挙体

日次
startTime*

Time string

パターン：^([01]\d|2[0-3]):([0-5]\d)$

アクションの抑制が開始される時刻。

時刻は 24 時間形式です。
endTime*

Time string

パターン：^([01]\d|2[0-3]):([0-5]\d)$

進行中のアクションの抑制が終了する時刻。

時刻は 24 時間形式です。
例
JSON 
{
"name": "Action Suppression With Daily Schedule",
"disableAgentReporting": false,
"suppressionScheduleType": "RECURRING",
"timezone": "Asia/Kolkata",
"startTime": null,
"endTime": null,
"recurringSchedule": {
"scheduleFrequency": "DAILY",
"startTime": "01:00",
"endTime": "01:22"
},
"affects": {
"affectedInfoType": "APPLICATION"
},
"healthRuleScope": null
}

週次スケジュール：設定の詳細

次のプロパティを使用して、週次でスケジュールされるアクションの抑制の詳細を設定します。

プロパティ名 タイプ 説明
scheduleFrequency * 文字列

アクションの抑制が特定の曜日に呼び出されます。

列挙体

毎週
days *

文字列

minItems：1 maxItems：7

アクションを抑制する曜日。

プロパティ名 タイプ 説明
DayOfWeek 文字列 Enums

日

月

火

水

木

金

土
startTime*

Time string

パターン：^([01]\d|2[0-3]):([0-5]\d)$

アクションの抑制が開始される時刻。

時刻は 24 時間形式です。
endTime*

Time string

パターン：^([01]\d|2[0-3]):([0-5]\d)$

進行中のアクションの抑制が終了する時刻。

時刻は 24 時間形式です。
例
JSON 
{ "name": "Action Suppression With Weekly Schedule", "disableAgentReporting": false,
"suppressionScheduleType": "RECURRING",
"timezone": "Asia/Kolkata",
"startTime": null,
"endTime": null,
"recurringSchedule": {
"scheduleFrequency": "WEEKLY",
"startTime": "06:00",
"endTime": "18:00",
"days": [
"SUNDAY",
"MONDAY"
]
},
"affects": {
"affectedInfoType": "APPLICATION"
},
"healthRuleScope": null
}

月次の特定の日付にスケジュール：設定の詳細

次のプロパティを使用して、月次の特定の日付にスケジュールされるアクションの抑制の詳細を設定します。

プロパティ名 タイプ 説明
scheduleFrequency * 文字列

アクションの抑制が毎月特定の日に呼び出されます。

列挙体

MONTHLY_SPECIFIC_DATE
startDate*

文字列

パターン：^(0[1-9]|[12][0-9]|3[01])$|^Last Day$

当該月でアクションを抑制する最初の日。
startTime*

Time string

パターン：^([01]\d|2[0-3]):([0-5]\d)$

アクションの抑制が開始される時刻。

時刻は 24 時間形式です。
endDate *

文字列

パターン：^(0[1-9]|[12][0-9]|3[01])$|^Last Day$

 当該月でアクションを抑制する最後の日。
endTime*

Time string

パターン：^([01]\d|2[0-3]):([0-5]\d)$

進行中のアクションの抑制が終了する時刻。

時刻は 24 時間形式です。
例
JSON 
{
"name": "Action Suppression With Monthly Specific Date Schedule",
"disableAgentReporting": false,
"suppressionScheduleType": "RECURRING",
"timezone": "Asia/Kolkata",
"startTime": null,
"endTime": null,
"recurringSchedule": {
"scheduleFrequency": "MONTHLY_SPECIFIC_DATE",
"startDate": "01",
"startTime": "06:00",
"endDate": "Last Day",
"endTime": "18:00"
},
"affects": {
"affectedInfoType": "APPLICATION"
},
"healthRuleScope": null
}

月次の特定の曜日にスケジュール：設定の詳細

次のプロパティを使用して、月次の特定の日付にスケジュールされるアクションの抑制の詳細を設定します。

プロパティ名 タイプ 説明
scheduleFrequency * 文字列

アクションの抑制が当該月の特定の曜日に呼び出されます。

列挙体

MONTHLY_SPECIFIC_DAY
startTime*

Time string

パターン：^([01]\d|2[0-3]):([0-5]\d)$

アクションの抑制が開始される時刻。

時刻は 24 時間形式です。
endTime*

Time string

パターン：^([01]\d|2[0-3]):([0-5]\d)$

進行中のアクションの抑制が終了する時刻。

時刻は 24 時間形式です。
days *

文字列

当該月でアクションを抑制する曜日。

プロパティ名 タイプ 説明
DayOfWeek 文字列 Enums

日

月

火

水

木

金

土
occurrence * 文字列 Enums

最初の

2 回目の

3 回目

第 4

LAST
例
JSON 
{
"name": "Action Suppression With Monthly Specific Day Schedule",
"disableAgentReporting": false,
"suppressionScheduleType": "RECURRING",
"timezone": "Asia/Kolkata",
"startTime": null,
"endTime": null,
"recurringSchedule": {
"scheduleFrequency": "MONTHLY_SPECIFIC_DAY",
"startTime": "06:00",
"endTime": "18:00",
"day": "SUNDAY",
"occurrence": "FIRST"
},
"affects": {
"affectedInfoType": "APPLICATION"
},
"healthRuleScope": null
}

スケジュールの頻度の詳細

このプロパティを使用して、アクションの抑制を呼び出す頻度を定義します。

プロパティ名 タイプ 説明
scheduleFrequency * 文字列
Enums

日次

毎週

MONTHLY_SPECIFIC_DATE

MONTHLY_SPECIFIC_DAY
例
JSON 
{
"recurringSchedule":{
"scheduleFrequency":"WEEKLY",
"startTime":"06:00",
"endTime":"18:00",
"days":[
"SUNDAY",
"MONDAY"
]
}

発生の詳細

当該月でアクションの抑制が発生する曜日。

プロパティ名 タイプ 説明
発生回数 文字列 Enums

最初の

2 回目の

3 回目

第 4

LAST
例
JSON 
{
"recurringSchedule":{
"scheduleFrequency":"MONTHLY_SPECIFIC_DAY",
"startTime":"06:00",
"endTime":"18:00",
"day":"SUNDAY",
"occurrence":"FIRST"
}
}

月次のアクションの抑制：曜日

当該月でアクションを抑制する曜日。

プロパティ名 タイプ 説明
DayOfWeek 文字列 Enums

日

月

火

水

木

金

土
例
JSON 
{
"recurringSchedule":{
"scheduleFrequency":"MONTHLY_SPECIFIC_DAY",
"startTime":"06:00",
"endTime":"18:00",
"day":"SUNDAY",
"occurrence":"FIRST"
}
}

アクションを抑制する時刻の詳細

このプロパティを使用して、アクションを抑制する時刻の詳細を定義します。

プロパティ名 タイプ 説明
時刻（Time）

文字列

パターン：^([01]\d|2[0-3]):([0-5]\d)$

時刻は 24 時間形式です。
例
JSON 
{
"recurringSchedule": {
"scheduleFrequency": "MONTHLY_SPECIFIC_DATE",
"startDate": "01",
"startTime": "06:00",
"endDate": "Last Day",
"endTime": "18:00"
}
}

タイムゾーン（Timezone）

プロパティ名 タイプ 説明
タイムゾーン

文字列

タイムゾーン ID。デフォルトのタイムゾーンはコントローラのタイムゾーンです。
例>
JSON 
{
"name": "Action Suppression With One Time Schedule",
"disableAgentReporting": false,
"suppressionScheduleType": "ONE_TIME",
"timezone": "Asia/Kolkata",
"startTime": "2020-06-18T13:33:37",
"endTime": "2021-06-30T16:48:37",
"recurringSchedule": null,
"affects": {
"affectedInfoType": "APPLICATION"
},
"healthRuleScope": null
}

アクションの抑制の影響を受けるエンティティ

アクションの抑制の影響を受けるエンティティに関する情報。

プロパティ名 タイプ 説明と有効な値

affectedInfoType

文字列

 Enums

アプリケーション

BUSINESS_TRANSACTIONS

TIERS_NODES

サーバー

DATABASES
例
JSON 
{
"affectedInfoType": "TIERS_NODES",
"affectedEntities": {
"tierNodeType": "NODE",
"nodeType": "ALL_NODES",
"affectedNodes": {
"affectedNodeScope": "NODES_OF_SPECIFIC_TIERS",
"specificTiers": ["Tier1"]
}
}
}

アクションの抑制の影響を受けるアプリケーションレベルのエンティティ

アプリケーションレベルでエンティティのアクションを抑制するために使用します。

プロパティ名 タイプ 説明と有効な値

affectedInfoType*

文字列

 列挙体

アプリケーション
例
JSON 
{
"affectedInfoType": "APPLICATION"
}

アクションの抑制の影響を受けるビジネストランザクション

ビジネストランザクション（BT）レベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値

affectedInfoType*

文字列

 列挙体

BUSINESS_TRANSACTIONS
affectedBusinessTransactions*

アクションの抑制の影響を受けるビジネストランザクションの範囲。

プロパティ名 タイプ 説明と有効な値
businessTransactionScope* 文字列 Enums

ALL_BUSINESS_TRANSACTIONS

SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN
例
JSON 
{
"affectedInfoType":"BUSINESS_TRANSACTIONS",
"affectedBusinessTransactions":{
"businessTransactionScope":"BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS",
"specificTiers":["DefaultTier1"]
}
}

影響を受けるビジネストランザクションの範囲

選択した BT タイプについて、BT レベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
businessTransactionScope* 文字列 Enums

ALL_BUSINESS_TRANSACTIONS

SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

すべてのタイプのビジネストランザクション

すべての BT について、BT レベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
businessTransactionScope* 文字列 列挙体

ALL_BUSINESS_TRANSACTIONS
例
JSON 
{
"affectedInfoType": "BUSINESS_TRANSACTIONS",
"affectedBusinessTransactions": {
"businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
}
}

特定のビジネストランザクション

特定の BT についてのみ BT レベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
businessTransactionScope* 文字列 列挙体

SPECIFIC_BUSINESS_TRANSACTIONS
businessTransactions*

文字列の配列

minItems: 1

アクションの抑制の影響を受ける特定のビジネストランザクション。例：

[CheckoutBt、LoginBt]
例
JSON 
{
"affectedInfoType": "BUSINESS_TRANSACTIONS",
"affectedBusinessTransactions": {
"businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
"businessTransactions": ["/BT/", "/BT/rest"]
}

特定の階層に関連付けられたビジネストランザクション

特定の階層内の BT についてのみ、BT レベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
businessTransactionScope* 文字列 列挙体

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS
specificTiers*

文字列の配列

minItems: 1

アクションの抑制の影響を受ける特定の階層に関連付けられたビジネストランザクション。例：

[CheckoutTier、LoginTier]
例
JSON 
{
"affectedInfoType":"BUSINESS_TRANSACTIONS",
"affectedBusinessTransactions":{
"businessTransactionScope":"BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS",
"specificTiers":["DefaultTier1"]
}
}

パターンに一致するビジネストランザクション

指定されたパターンに一致するプロパティを持つ BT について、BT レベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
businessTransactionScope* 文字列 Enums

BUSINESS_TRANSACTIONS_MATCHING_PATTERN
patternMatcher*

EntityMatchingPattern
プロパティ名 タイプ 説明と有効な値
文字列
パターン照合値。
パターンの一致条件を逆にするには、これを選択します。
matchTo* 文字列 Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX
matchValue*

文字列

minLength: 1

 パターン照合値。
shouldNot

boolean

デフォルト：false

 パターンの一致条件を逆にするには、これを選択します。
例
JSON 
{
"affectedInfoType": "BUSINESS_TRANSACTIONS",
"affectedBusinessTransactions": {
"businessTransactionScope": "BUSINESS_TRANSACTIONS_MATCHING_PATTERN",
"patternMatcher": {
"matchTo": "STARTS_WITH",
"matchValue": "E",
"shouldNot": false
}
}
}

影響を受ける階層またはノードのエンティティ

階層レベルまたはノードレベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値

affectedInfoType

文字列

 列挙体

TIERS_NODES
affectedEntities* TierNodeEntities
プロパティ名 タイプ 説明と有効な値
tierNodeType* 文字列 Enums

TIER

ノード
例
JSON 
{
"affectedInfoType": "TIERS_NODES",
"affectedEntities": {
"tierNodeType": "NODE",
"nodeType": "ALL_NODES",
"affectedNodes": {
"affectedNodeScope": "NODES_OF_SPECIFIC_TIERS",
"specificTiers": ["Tier1"]
}
}
}

影響を受ける階層またはノードのエンティティ

階層レベルまたはノードレベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
tierNodeType* 文字列 Enums

TIER

ノード

影響を受ける階層レベルのエンティティ

プロパティ名 タイプ 説明と有効な値
tierNodeType* 文字列 列挙体

TIER
affectedTiers* AffectedTiers
プロパティ名 タイプ 説明と有効な値
affectedTierScope* 文字列 Enums

ALL_TIERs

SPECIFIC_TIERS
例
JSON 
{
"affectedInfoType": "TIERS_NODES",
"affectedEntities": {
"tierNodeType": "TIER",
"affectedTiers": {
"affectedTierScope": "SPECIFIC_TIERS",
"tiers": ["ECommerce-Services", "Inventory-Services"]
}
}
}

影響を受けるノードレベルのエンティティ

プロパティ名 タイプ 説明と有効な値
tierNodeType* 文字列 列挙体

ノード
nodeType* 文字列 Enums

ALL_NODES

JAVA_NODES

DOT_NET_NODES

PHP_NODES
affectedNodes* AffectedNodes
プロパティ名 タイプ 説明と有効な値
affectedNodeScope* 文字列 Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER
例
JSON 
{
"affectedInfoType": "TIERS_NODES",
"affectedEntities": {
"tierNodeType": "NODE",
"nodeType": "ALL_NODES",
"affectedNodes": {
"affectedNodeScope": "NODES_OF_SPECIFIC_TIERS",
"specificTiers": ["Tier1"]
}
}
}

影響を受ける階層範囲

プロパティ名 タイプ 説明と有効な値
affectedTierScope* 文字列 Enums

ALL_TIERs

SPECIFIC_TIERS

全階層

すべての階層について、階層レベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
affectedTierScope* 文字列 列挙体

ALL_TIERS
例
JSON 
{
"affectedInfoType": "TIERS_NODES",
"affectedEntities": {
"tierNodeType": "TIER",
"affectedTiers": {
"affectedTierScope": "ALL_TIERS"
}
}
}

特定の階層

特定の階層についてのみ、階層レベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
affectedTierScope* 文字列 列挙体

SPECIFIC_TIERS
tiers*

文字列の配列

minItems: 1
例
JSON 
{
"affectedInfoType": "TIERS_NODES",
"affectedEntities": {
"tierNodeType": "TIER",
"affectedTiers": {
"affectedTierScope": "SPECIFIC_TIERS",
"tiers": ["ECommerce-Services", "Inventory-Services"]
}
}
}

影響を受けるノード

プロパティ名 タイプ 説明と有効な値
affectedNodeScope* 文字列 Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER
例
JSON 
{
"affectedNodeScope": "NODES_OF_SPECIFIC_TIERS",
"specificTiers": ["Tier1"]
}

すべてのノード

すべてのノードについて、ノードレベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
affectedNodeScope* 文字列 列挙体

ALL_NODES
例
JSON 
{
"affectedInfoType": "TIERS_NODES",
"affectedEntities": {
"tierNodeType": "NODE",
"nodeType": "ALL_NODES",
"affectedNodes": {
"affectedNodeScope": "ALL_NODES"
}
}
}

特定のノード（Specific Nodes）

特定のノードについてのみ、ノードレベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
affectedNodeScope* 文字列 列挙体

SPECIFIC_NODES
nodes*

文字列の配列

minItems: 1

アクションの抑制の影響を受けるエンティティと見なされるノードのリスト。例：

ノード 1（Node 1）とノード 2（Node 2）
例
JSON 
{
"affectedInfoType": "TIERS_NODES",
"affectedEntities": {
"tierNodeType": "NODE",
"nodeType": "ALL_NODES",
"affectedNodes": {
"affectedNodeScope": "SPECIFIC_NODES",
"nodes": ["Node1", "Node2"]
}
}
}

特定の階層内のノード

特定の階層内のノードについてのみ、ノードレベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
affectedNodeScope* 文字列 列挙体

NODES_OF_SPECIFIC_TIERS
specificTiers*

文字列の配列

minItems: 1
例
JSON 
{
"affectedInfoType": "TIERS_NODES",
"affectedEntities": {
"tierNodeType": "NODE",
"nodeType": "ALL_NODES",
"affectedNodes": {
"affectedNodeScope": "NODES_OF_SPECIFIC_TIERS",
"specificTiers": ["ECommerce-Services", "Inventory-Services"]
}
}
}

パターンに一致するノード

パターンに一致するプロパティを持つノードについて、ノードレベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
affectedNodeScope* 文字列 列挙体

NODES_MATCHING_PATTERN
patternMatcher*

EntityMatchingPattern
プロパティ名 タイプ 説明
matchTo* 文字列 Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX
matchValue*

文字列

minLength: 1

 パターン照合値。
shouldNot

boolean

デフォルト：false

 パターンの一致条件を逆にする場合は、これを選択します。
例
JSON 
{
"affectedInfoType": "TIERS_NODES",
"affectedEntities": {
"tierNodeType": "NODE",
"nodeType": "ALL_NODES",
"affectedNodes": {
"affectedNodeScope": "NODES_MATCHING_PATTERN",
"patternMatcher": {
"matchTo": "STARTS_WITH",
"matchValue": "A",
"shouldNot": false
}
}
}
}

ノードプロパティ変数マッチ機能

指定された環境変数に一致するノードについて、ノードレベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
affectedNodeScope* 文字列 列挙体

NODE_PROPERTY_VARIABLE_MATCHER
propVarPairs*
プロパティ名 タイプ 説明
propertyType* 文字列 Enums

META

ENV

JVM
name*

文字列

minLength: 1
value*

文字列

minLength: 1
例
JSON 
{
"affectedInfoType": "TIERS_NODES",
"affectedEntities": {
"tierNodeType": "NODE",
"nodeType": "ALL_NODES",
"affectedNodes": {
"affectedNodeScope": "NODE_PROPERTY_VARIABLE_MATCHER",
"propVarPairs": [{
"propertyType": "ENV",
"name": "CLASSPATH",
"value": "C:\\Users\\Java\\Classes"
}]
}
}
}

アプリケーション内で影響を受けるサーバー

サーバレベルでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明

affectedInfoType

文字列

 列挙体

サーバー
affectedServers* ApplicationAffectedServers
プロパティ名 タイプ 説明
serversScope* 文字列 列挙体

SPECIFIC_SERVERS_IN_APPLICATION
例
JSON 
{
"affectedInfoType":"SERVERS",
"affectedServers":{
"serversScope":"SPECIFIC_SERVERS_IN_APPLICATION",
"specificServers":["DropWizardTestApplicationDropWizardDefaultNode1"]
}
}

アプリケーション内の特定のサーバ

アプリケーション内の特定のサーバについて、サーバレベルでエンティティのアクションを抑制するには、このプロパティを使用します。

プロパティ名 タイプ 説明
serversScope* 文字列 列挙体

SPECIFIC_SERVERS_IN_APPLICATION

specificServers*

文字列の配列

minItems: 1

minLength: 1

アクションの抑制の影響を受けるエンティティと見なされるサーバのリスト。例：

["server1", "server2"]
例
JSON 
{
"affectedInfoType":"SERVERS",
"affectedServers":{
"serversScope":"SPECIFIC_SERVERS_IN_APPLICATION",
"specificServers":["DropWizardTestApplicationDropWizardDefaultNode1"]
}
}

サーバーアプリケーションのサーバー

サーバーレベルのサーバーでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
affectedInfoType* 文字列 列挙体

SERVERS_IN_SERVERS_APP
serversAffectedEntities*

ServersAffectedEntities

プロパティ名 タイプ 説明
selectServersBy* 文字列

列挙体

AFFECTED_SERVER_SUBGROUPS

AFFECTED_SERVERS

影響を受けるサーバーの範囲

アカウントまたはサブグループレベルのサーバーでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
selectServersBy* 文字列 列挙体

AFFECTED_SERVERS
affectedServers*

ServerSelectionCriteria

プロパティ名 タイプ 説明と有効な値
severSelectionScope* 文字列

Enums

ALL_SERVERS_IN_ACCOUNT

SERVERS_WITHIN_SUBGROUP

SPECIFIC_SERVERS

SERVERS_MATCHING_PATTERN

影響を受けるサーバーの範囲 - アカウント内のすべてのサーバー

アカウントのすべてのサーバーでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
severSelectionScope* 文字列 列挙体

ALL_SERVERS_IN_ACCOUNT
例
JSON 
{
"affectedInfoType":"SERVERS_IN_SERVERS_APP",
"serversAffectedEntities":{
"selectServersBy":"AFFECTED_SERVERS",
"affectedServers":{
"severSelectionScope":"ALL_SERVERS_IN_ACCOUNT"
}
}
}

影響を受けるサーバーの範囲 - サブグループ内のサーバー

指定されたサブグループ内のすべてのサーバーでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
severSelectionScope* 文字列 列挙体

SERVERS_WITHIN_SUBGROUP
subGroups*

文字列の配列

minItems: 1

 選択したエンティティのアイデンティティ（ID）。
例
JSON 
{
"affectedInfoType":"SERVERS_IN_SERVERS_APP",
"serversAffectedEntities":{
"selectServersBy":"AFFECTED_SERVERS",
"affectedServers":{
"severSelectionScope":"SERVERS_WITHIN_SUBGROUP",
"subGroups":[24, 34]
}
}
}

影響を受けるサーバーの範囲 - 特定のサーバー

指定されたサーバーでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
severSelectionScope* 文字列 列挙体

SPECIFIC_SERVERS
servers*

文字列の配列

minItems: 1

選択したエンティティの ID。
例
JSON 
{
"affectedInfoType":"SERVERS_IN_SERVERS_APP",
"serversAffectedEntities":{
"selectServersBy":"AFFECTED_SERVERS",
"affectedServers":{
"severSelectionScope":"SPECIFIC_SERVERS",
"servers":[404, 124]
}
}
}

影響を受けるサーバーの範囲 - 一致するパターンを持つサーバー

パターンに一致するプロパティを持つサーバーでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
severSelectionScope* 文字列 列挙体

SERVERS_MATCHING_PATTERN
patternMatcher*

EntityMatchingPattern

プロパティ名 タイプ 説明
matchTo* 文字列

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX
matchValue*

文字列

minLength: 1

 パターン照合値。
shouldNot

boolean

デフォルト：false

 パターンの一致条件を逆にする場合は、これを選択します。
例
JSON 
{
"affectedInfoType":"SERVERS_IN_SERVERS_APP",
"serversAffectedEntities":{
"selectServersBy":"AFFECTED_SERVERS",
"affectedServers":{
"severSelectionScope":"SERVERS_MATCHING_PATTERN",
"patternMatcher":{
"matchValue":"ecommerce",
"shouldNot":false,
"matchTo":"STARTS_WITH"
}
}
}
}

サブグループ内の影響を受けるサーバーの範囲

サブグループ内のサーバーでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
selectServersBy* 文字列 列挙体

AFFECTED_SERVER_SUBGROUPS
subGroups*

AffectedSubGroups

プロパティ名 タイプ 説明と有効な値
subGroupScope* 文字列

Enums

ALL_SUBGROUPS

SPECIFIC_SERVER_SUB_GROUPS

サブグループ内の影響を受けるサーバーの範囲 - すべてのサブグループ

すべてのサブグループレベル内のサーバーでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値

subGroupScope*

文字列

 列挙体

ALL_SUBGROUPS
例
JSON 
{
"affectedInfoType":"SERVERS_IN_SERVERS_APP",
"serversAffectedEntities":{
"selectServersBy":"AFFECTED_SERVER_SUBGROUPS",
"subGroups":{
"subGroupScope":"ALL_SUBGROUPS",
}
}
}

サブグループ内の影響を受けるサーバーの範囲 - 特定のサブグループ内のサーバー

特定のサブグループレベル内のサーバーでエンティティのアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明と有効な値
subGroupScope* 文字列 列挙体

SPECIFIC_SERVER_SUB_GROUPS
subGroupNames*

文字列の配列

minItems: 1

選択したエンティティの ID。
例
JSON 
{
"affectedInfoType":"SERVERS_IN_SERVERS_APP",
"serversAffectedEntities":{
"selectServersBy":"AFFECTED_SERVER_SUBGROUPS",
"subGroups":{
"subGroupScope":"SPECIFIC_SERVER_SUB_GROUPS",
"subGroupNames":[43, 45]
}
}
}

影響を受けるデータベース

データベースレベルでエンティティのアクションを抑制するには、このプロパティを使用します。

プロパティ名 タイプ 説明と有効な値

affectedInfoType

文字列

 列挙体

DATABASES
affectedDatabases* AffectedDatabases
プロパティ名 タイプ 説明
databaseScope* 文字列
プロパティ名 タイプ 説明
AffectedDatabaseType 文字列 Enums

ALL_DATABASES

SPECIFIC_DATABASES
例
JSON 
{
"affects":{
"affectedInfoType":"DATABASES",
"affectedDatabases":{
"databaseScope":"ALL_DATABASES"
}

影響を受けるデータベースの範囲

データベースレベルでアクションの抑制範囲を定義するには、このプロパティを使用します。

プロパティ名 タイプ 説明
databaseScope* 文字列
プロパティ名 タイプ 説明
AffectedDatabaseType 文字列 Enums

ALL_DATABASES

SPECIFIC_DATABASES

影響を受けるデータベースの範囲：すべてのデータベース

すべてのデータベースのエンティティに対するアクションを抑制するには、このプロパティを使用します。

プロパティ名 タイプ 説明
databaseScope* 文字列
プロパティ名 タイプ 説明
AffectedDatabaseType 文字列 Enums

ALL_DATABASES

影響を受けるデータベースの範囲：特定のデータベース

特定のデータベースのエンティティに対するアクションを抑制するには、このプロパティを使用します。

プロパティ名 タイプ 説明
databaseScope* 文字列
プロパティ名 タイプ 説明
AffectedDatabaseType 文字列 Enums

SPECIFIC_DATABASES
databases *

文字列の配列

minItems: 1

 DbServer
プロパティ名 タイプ

serverName*

文字列

minLength: 1
collectorConfigName*

文字列

minLength: 1
例
JSON 
{
"affects":{
"affectedInfoType":"DATABASES",
"affectedDatabases":{
"databaseScope":"SPECIFIC_DATABASES",
"databases":[
{
"serverName":"MongoNewKC",
"collectorConfigName":"MongoNewKC"
},
{
"serverName":"Collector41",
"collectorConfigName":"Collector41"
}
]
}
}
}

データベースサーバの詳細

データベースサーバの詳細を定義するには、このプロパティを使用します。

プロパティ名 タイプ

serverName

文字列

minLength: 1
collectorConfigName *

文字列

minLength: 1

影響を受けるデータベースタイプ

影響を受けるデータベースの範囲を定義するには、このプロパティを使用します。

プロパティ名 タイプ 説明
AffectedDatabaseType 文字列 Enums

ALL_DATABASES

SPECIFIC_DATABASES

正常性ルールの範囲

正常性ルール違反イベントへの応答としてトリガーされるアクションを抑制するには、これを使用します。

プロパティ名 タイプ 説明
healthRuleScopeType* 文字列 [HealthRuleScopeType Enum]

SPECIFIC_HEALTH_RULES
例
JSON 
{
"healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
"healthRules": ["CPU utilization is too high", "JVM Garbage Collection Time is too high"]
}

正常性ルールの範囲タイプ

プロパティ名 タイプ 説明
healthRuleScope* 文字列 列挙体

SPECIFIC_HEALTH_RULES

特定の正常性ルール

プロパティ名 タイプ 説明
healthRuleScopeType* 文字列 [HealthRuleScopeType Enum]

SPECIFIC_HEALTH_RULES
healthRules*

文字列の配列

minItems: 1
例
JSON 
{
"healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
"healthRules": ["CPU utilization is too high", "JVM Garbage Collection Time is too high"]
}

アクションの抑制の概要

プロパティ名 タイプ
id* 整数

name*

文字列

minLength: 1

エラー応答

プロパティ名 タイプ
statusCode 整数

message

文字列

* このプロパティは必須です。