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

注

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

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

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

リソースURL

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

要求/応答の形式

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
}
JSON


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

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

リソースURL

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

応答形式

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"
 }
]
JSON


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

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

リソースURL

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

応答形式

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

アクションの抑制の更新

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

リソースURL

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

要求/応答の形式

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
}
JSON

アクションの抑制の削除

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

リソースURL

DELETE <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-by-name/?name=<ActionSuppressionName>

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

応答形式

JSON

応答の例

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

応答コード

コード

説明

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

Property Details

アクションの抑制

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

プロパティ名

タイプ

説明と有効な値

id 整数

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

これは readOnly 値です。

name*

string

minLength: 1
maxLength: 100

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

disableAgentReporting

boolean

デフォルト：false

有効にした場合、範囲内に定義されているエージェントは、指定されたタイムフレーム中にメトリックデータを報告しません。

disableAgentReporting を true に設定した場合、繰り返しアクションの抑制を定義できません。

suppressionScheduleType

string

デフォルト：ONE_TIME

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

Enums

ONE_TIME

RECURRING

timezonestring

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

startTime

string

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

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

endTime

string

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

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

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

プロパティ名タイプ説明
scheduleFrequency*string

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

Enums

DAILY

WEEKLY

MONTHLY_SPECIFIC_DATE

MONTHLY_SPECIFIC_DAY


affects*


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

プロパティ名タイプ説明
affectedInfoType*string

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

Enums

APPLICATION

BUSINESS_TRANSACTIONS

TIERS_NODES

SERVERS

DATABASES

healthRuleScope*

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

プロパティ名タイプ説明
healthRuleScopeType*string

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

Enums

SPECIFIC_HEALTH_RULES

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

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

プロパティ名タイプ説明
ActionSuppressionScheduleTypestring

Enums

ONE_TIME

RECURRING

1 回限りのアクションの抑制の例
{
    "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
}
JSON

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

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

プロパティ名タイプ説明
scheduleFrequency*string

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

Enums

DAILY

WEEKLY

MONTHLY_SPECIFIC_DATE

MONTHLY_SPECIFIC_DAY

日次でスケジュールされている繰り返しアクションの抑制の例
{
    "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
}
JSON

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

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

プロパティ名タイプ説明
scheduleFrequency*string

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

列挙体

DAILY

startTime*

Time string

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

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

時刻は 24 時間形式です。

endTime*

Time string

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

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

時刻は 24 時間形式です。

例
{
    "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
}
JSON

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

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

プロパティ名タイプ説明
scheduleFrequency*string

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

列挙体

WEEKLY

days*

string

minItems：1 maxItems：7

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

プロパティ名タイプ説明
DayOfWeekstring

Enums

SUNDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

startTime*

Time string

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

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

時刻は 24 時間形式です。

endTime*

Time string

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

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

時刻は 24 時間形式です。

例
{ "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
}
JSON

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

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

プロパティ名タイプ説明
scheduleFrequency*string

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

列挙体

MONTHLY_SPECIFIC_DATE

startDate*

string

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

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


startTime*

Time string

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

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

時刻は 24 時間形式です。

endDate*

string

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

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

Time string

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

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

時刻は 24 時間形式です。

例
{
    "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
}
JSON

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

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

プロパティ名タイプ説明
scheduleFrequency*string

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

列挙体

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*

string

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

プロパティ名タイプ説明
DayOfWeekstring

Enums

SUNDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

occurrence*string

Enums

FIRST

SECOND

THIRD

FOURTH

LAST

例
{
    "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
}
JSON

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

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

プロパティ名タイプ説明
scheduleFrequency*string

Enums

DAILY

WEEKLY

MONTHLY_SPECIFIC_DATE

MONTHLY_SPECIFIC_DAY

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

発生の詳細

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

プロパティ名タイプ説明
occurrencestring

Enums

FIRST

SECOND

THIRD

FOURTH

LAST

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

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

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

プロパティ名タイプ説明
DayOfWeekstring

Enums

SUNDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

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

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

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

プロパティ名タイプ説明
Time

string

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

時刻は 24 時間形式です。

例
{
        "recurringSchedule": {
        "scheduleFrequency": "MONTHLY_SPECIFIC_DATE",
        "startDate": "01",
        "startTime": "06:00",
        "endDate": "Last Day",
        "endTime": "18:00"
    }
}
JSON

タイムゾーン（Timezone）

プロパティ名タイプ説明
Timezone

string

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

例
{
    "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
}
JSON

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

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

プロパティ名

タイプ

説明と有効な値

affectedInfoType*

string

Enums

APPLICATION

BUSINESS_TRANSACTIONS

TIERS_NODES

SERVERS

DATABASES

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

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

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

プロパティ名

タイプ

説明と有効な値

affectedInfoType*

string

列挙体

APPLICATION

例
{
    "affectedInfoType": "APPLICATION"
}
JSON

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

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

プロパティ名

タイプ

説明と有効な値

affectedInfoType*

string

列挙体

BUSINESS_TRANSACTIONS

affectedBusinessTransactions*

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

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

Enums

ALL_BUSINESS_TRANSACTIONS

SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

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

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

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

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

Enums

ALL_BUSINESS_TRANSACTIONS

SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

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

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

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

列挙体

ALL_BUSINESS_TRANSACTIONS

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

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

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

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

列挙体

SPECIFIC_BUSINESS_TRANSACTIONS

businessTransactions*

文字列の配列

minItems: 1

アクションの抑制の影響を受ける特定のビジネストランザクション。次に例を示します。

[CheckoutBt, LoginBt]

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

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

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

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

列挙体

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

specificTiers*

文字列の配列

minItems: 1

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

[CheckoutTier, LoginTier]

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

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

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

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

Enums

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

patternMatcher*


EntityMatchingPattern

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

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue*

文字列

minLength: 1

パターン照合値。
shouldNot

boolean

デフォルト：false

パターンの一致条件を逆にするには、これを選択します。


例
{
		"affectedInfoType": "BUSINESS_TRANSACTIONS",
		"affectedBusinessTransactions": {
			"businessTransactionScope": "BUSINESS_TRANSACTIONS_MATCHING_PATTERN",
			"patternMatcher": {
				"matchTo": "STARTS_WITH",
				"matchValue": "E",
				"shouldNot": false
			}
		}
	}
JSON

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

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

プロパティ名

タイプ

説明と有効な値

affectedInfoType*

string

列挙体

TIERS_NODES

affectedEntities*

TierNodeEntities

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

Enums

TIER

NODE

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

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

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

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

Enums

TIER

NODE

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

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

列挙体

TIER

affectedTiers*

AffectedTiers

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

Enums

ALL_TIERs

SPECIFIC_TIERS

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

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

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

列挙体

NODE

nodeType*string

Enums

ALL_NODES

JAVA_NODES

DOT_NET_NODES

PHP_NODES

affectedNodes*

AffectedNodes

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

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

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

影響を受ける階層範囲

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

Enums

ALL_TIERs

SPECIFIC_TIERS

全階層

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

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

列挙体

ALL_TIERS

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

特定の階層

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

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

列挙体

SPECIFIC_TIERS

tiers*

文字列の配列

minItems: 1


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

影響を受けるノード

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

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

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

すべてのノード

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

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

列挙体

ALL_NODES

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

特定のノード（Specific Nodes）

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

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

列挙体

SPECIFIC_NODES

nodes*

文字列の配列

minItems: 1

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

[Node1, Node2]

例
{
		"affectedInfoType": "TIERS_NODES",
		"affectedEntities": {
			"tierNodeType": "NODE",
			"nodeType": "ALL_NODES",
			"affectedNodes": {
				"affectedNodeScope": "SPECIFIC_NODES",
				"nodes": ["Node1", "Node2"]
			}
		}
	}
JSON

特定の階層内のノード

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

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

列挙体

NODES_OF_SPECIFIC_TIERS

specificTiers*

文字列の配列

minItems: 1


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

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

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

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

列挙体

NODES_MATCHING_PATTERN

patternMatcher*


EntityMatchingPattern

プロパティ名タイプ説明
matchTo*string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue*

文字列

minLength: 1

パターン照合値。
shouldNot

boolean

デフォルト：false

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

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

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

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

列挙体

NODE_PROPERTY_VARIABLE_MATCHER

propVarPairs*


プロパティ名タイプ説明
propertyType*string

Enums

META

ENV

JVM

name*

string

minLength: 1


value*

string

minLength: 1


例
{
	"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"
			}]
		}
	}
}
JSON

影響を受けるサーバ

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

プロパティ名

タイプ

説明と有効な値

affectedInfoType*

string

列挙体

SERVERS

affectedServers*

ApplicationAffectedServers

プロパティ名タイプ説明
serversScope*string

列挙体

SPECIFIC_SERVERS_IN_APPLICATION


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

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

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

プロパティ名タイプ説明
serversScope*string

列挙体

SPECIFIC_SERVERS_IN_APPLICATION


specificServers*


文字列の配列

minItems: 1

minLength: 1

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

[server1, server2]

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

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

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

プロパティ名

タイプ

説明と有効な値

affectedInfoType*

string

列挙体

DATABASES

affectedDatabases*

AffectedDatabases

プロパティ名タイプ説明
databaseScope*string
プロパティ名タイプ説明
AffectedDatabaseType string

Enums

ALL_DATABASES

SPECIFIC_DATABASES


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

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

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

プロパティ名タイプ説明
databaseScope*string
プロパティ名タイプ説明
AffectedDatabaseTypestring

Enums

ALL_DATABASES

SPECIFIC_DATABASES

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

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

プロパティ名タイプ説明
databaseScope*string
プロパティ名タイプ説明
AffectedDatabaseTypestring

Enums

ALL_DATABASES

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

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

プロパティ名タイプ説明
databaseScope*string
プロパティ名タイプ説明
AffectedDatabaseTypestring

Enums

SPECIFIC_DATABASES

databases*

文字列の配列

minItems: 1

DbServer

プロパティ名

タイプ

serverName*

string

minLength: 1

collectorConfigName*

string

minLength: 1

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

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

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

プロパティ名

タイプ

serverName*

string

minLength: 1

collectorConfigName*

string

minLength: 1

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

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

プロパティ名タイプ説明
AffectedDatabaseTypestring

Enums

ALL_DATABASES

SPECIFIC_DATABASES

正常性ルールの範囲

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

プロパティ名タイプ説明
healthRuleScopeType*string

HealthRuleScopeType

列挙体

SPECIFIC_HEALTH_RULES

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

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

プロパティ名タイプ説明
healthRuleScope*string

列挙体

SPECIFIC_HEALTH_RULES

特定の正常性ルール

プロパティ名タイプ説明
healthRuleScopeType*string

HealthRuleScopeType

列挙体

SPECIFIC_HEALTH_RULES

healthRules*

文字列の配列

minItems: 1


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

アクションの抑制の概要

プロパティ名

タイプ

id*整数

name*

文字列

minLength: 1

エラー応答

プロパティ名

タイプ

statusCode整数

message

文字列

*This property is required.

例のダウンロード

Appdynamics Action Suppression examples.zip をダウンロードして、スケジュールを設定するのに役立つ一連の例を取得します。 

SWAGGER YAML ファイルのダウンロード

Swagger YAML 仕様 action_suppression_openapi.yml をダウンロードします。