Download PDF
Download page 電子メールダイジェスト API.
電子メールダイジェスト API
このページでは、正常性ルールのスケジュールで設定された受信者リストへ特定のイベントの概要を報告する際に使用できる、電子メールダイジェスト API メソッドについて説明します。電子メールダイジェストは、正常性ルール違反イベントへの応答としてトリガーされます。
JSON ペイロードの構文検証は、電子メールダイジェストの作成時に実行されます。
新しい電子メールダイジェストの作成
指定された JSON ペイロードを使用して新しい電子メールダイジェストを作成します。「プロパティの詳細」を参照してください。
リソースURL
POST <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests
要求/応答の形式
JSON
例
この例では、新しい電子メールダイジェストを作成します。「例のダウンロード」を参照してください。
{
"name": "My new email digest",
"enabled": true,
"executeActionsInBatch": true,
"frequency": 2,
"actions": [
{
"actionName": "My action 1",
"actionType": "SMS"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_UPGRADED"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"CLR_CRASH",
"DEADLOCK"
],
"anomalyEvents": [
"ANOMALY_OPEN_WARNING",
"ANOMALY_CLOSE_CRITICAL"
],
"customEvents": [
{
"eventName": "string",
"propertyMatchCriteria": "ANY",
"keyValuePairArray": [
{
"key": "key1",
"value": "value1"
}
]
}
]
},
"selectedEntities": {
"selectedEntityType": "ANY_ENTITY"
}
}
この例では、作成された電子メール ダイジェスト オブジェクトを返します。
{
"id": 0,
"name": "My new email digest",
"enabled": true,
"executeActionsInBatch": true,
"frequency": 2,
"actions": [
{
"actionName": "My action 1",
"actionType": "SMS"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_UPGRADED"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"CLR_CRASH",
"DEADLOCK"
],
"anomalyEvents": [
"ANOMALY_OPEN_WARNING",
"ANOMALY_CLOSE_CRITICAL"
],
"customEvents": [
{
"eventName": "string",
"propertyMatchCriteria": "ANY",
"keyValuePairArray": [
{
"key": "key1",
"value": "value1"
}
]
}
]
},
"selectedEntities": {
"selectedEntityType": "ANY_ENTITY"
}
}
アプリケーションの電子メールダイジェストのリストの取得
この API は、特定のアプリケーションに保持されている電子メールダイジェストの名前、ID、および enable フラグの詳細を返します。「プロパティの詳細」を参照してください。
リソースURL
GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests
応答形式
JSON
応答の例
この例では、指定されたアプリケーション ID に関連する電子メールダイジェストのリストを返します。
[
{
"id": 1080,
"name": "Digest 1",
"enabled": true,
"actions": [
{
"actionName": "alertingcsaasqe@gmail.com",
"actionType": "EMAIL"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_OPEN_WARNING",
"HEALTH_RULE_OPEN_CRITICAL",
"HEALTH_RULE_UPGRADED",
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_CONTINUES_WARNING"
],
"healthRuleScopeType": "ALL_HEALTH_RULES",
"healthRuleCount": null
},
"otherEvents": [],
"anomalyEvents": null,
"customEvents": []
},
"selectedEntityType": "ANY_ENTITY"
},
{
"id": 1079,
"name": "Digest 2",
"enabled": true,
"actions": [
{
"actionName": "action@email.com",
"actionType": "EMAIL"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_OPEN_WARNING"
],
"healthRuleScopeType": "ALL_HEALTH_RULES",
"healthRuleCount": null
},
"otherEvents": [],
"anomalyEvents": null,
"customEvents": []
},
"selectedEntityType": "ANY_ENTITY"
},
{
"id": 1052,
"name": "Digest 3",
"enabled": true,
"actions": [
{
"actionName": "action@email.com",
"actionType": "EMAIL"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_OPEN_CRITICAL"
],
"healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
"healthRuleCount": 1
},
"otherEvents": [],
"anomalyEvents": null,
"customEvents": []
},
"selectedEntityType": "ANY_ENTITY"
}
]
電子メールダイジェストの詳細の取得
指定された ID を持つ電子メールダイジェストの詳細を取得します。「プロパティの詳細」を参照してください。
有効な電子メールダイジェスト ID が指定されていることを確認してください。
リソースURL
GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests/{email-digest-id}
応答形式
JSON
応答の例
{
"id": 0,
"name": "My new email digest",
"enabled": true,
"executeActionsInBatch": true,
"frequency": 2,
"actions": [
{
"actionName": "My action 1",
"actionType": "SMS"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_UPGRADED"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"CLR_CRASH",
"DEADLOCK"
],
"anomalyEvents": [
"ANOMALY_OPEN_WARNING",
"ANOMALY_CLOSE_CRITICAL"
],
"customEvents": [
{
"eventName": "string",
"propertyMatchCriteria": "ANY",
"keyValuePairArray": [
{
"key": "key1",
"value": "value1"
}
]
}
]
},
"selectedEntities": {
"selectedEntityType": "ANY_ENTITY"
}
}
電子メールダイジェストの更新
指定された JSON ペイロードを使用して既存の電子メールダイジェストを更新します。「プロパティの詳細」を参照してください。
この要求には、入力として完全な JSON ペイロードが必要です。そのため、
GET email-digests/{email-digest-id} を使用して JSON ペイロードを取得し、必要なフィールドを更新することを推奨します。その後、変更したペイロードをPUT要求の一部として送信します。
リソースURL
PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests/{email-digest-id}
要求/応答の形式
JSON
例
この例では、アクションを更新します。「例のダウンロード」を参照してください。
{
"name": "My new email digest",
"enabled": true,
"executeActionsInBatch": true,
"frequency": 2,
"actions": [
{
"actionName": "My action 1",
"actionType": "SMS"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_UPGRADED"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"CLR_CRASH",
"DEADLOCK"
],
"anomalyEvents": [
"ANOMALY_OPEN_WARNING",
"ANOMALY_CLOSE_CRITICAL"
],
"customEvents": [
{
"eventName": "string",
"propertyMatchCriteria": "ANY",
"keyValuePairArray": [
{
"key": "key1",
"value": "value1"
}
]
}
]
},
"selectedEntities": {
"selectedEntityType": "ANY_ENTITY"
}
}
この例では、更新されたアクションを返します。
{
"id": 0,
"name": "My new email digest",
"enabled": true,
"executeActionsInBatch": true,
"frequency": 2,
"actions": [
{
"actionName": "My action 1",
"actionType": "SMS"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_UPGRADED"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"CLR_CRASH",
"DEADLOCK"
],
"anomalyEvents": [
"ANOMALY_OPEN_WARNING",
"ANOMALY_CLOSE_CRITICAL"
],
"customEvents": [
{
"eventName": "string",
"propertyMatchCriteria": "ANY",
"keyValuePairArray": [
{
"key": "key1",
"value": "value1"
}
]
}
]
},
"selectedEntities": {
"selectedEntityType": "ANY_ENTITY"
}
}
電子メールダイジェストの削除
指定された ID を持つ電子メールダイジェストを削除します。「プロパティの詳細」を参照してください。
有効な電子メールダイジェスト ID が指定されていることを確認してください。
リソースURL
DELETE <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests/{email-digest-id}
電子メールダイジェストの 1 つ以上のプロパティの更新
指定された JSON ペイロードを使用して既存の電子メールダイジェストのプロパティを更新します。「プロパティの詳細」を参照してください。
リソースURL
PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests/{email-digest-id}/configuration
要求/応答の形式
JSON
例
この例では、指定された電子メールダイジェストのプロパティを更新します。
{
"enabled": true,
"emailDigestName": "test email digest",
"frequency": 2
}
この例では、指定された電子メールダイジェストについて、更新されたプロパティを返します。
{
"id": 0,
"name": "My new email digest",
"enabled": true,
"executeActionsInBatch": true,
"frequency": 2,
"actions": [
{
"actionName": "My action 1",
"actionType": "SMS"
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_UPGRADED"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"CLR_CRASH",
"DEADLOCK"
],
"anomalyEvents": [
"ANOMALY_OPEN_WARNING",
"ANOMALY_CLOSE_CRITICAL"
],
"customEvents": [
{
"eventName": "string",
"propertyMatchCriteria": "ANY",
"keyValuePairArray": [
{
"key": "key1",
"value": "value1"
}
]
}
]
},
"selectedEntities": {
"selectedEntityType": "ANY_ENTITY"
}
}
応答コード
コード | 説明 |
|---|---|
| 200 | 正常に取得されました |
| 201 | 正常に作成されました |
| 204 | 正常に削除されました |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | リソースが見つかりません |
| 409 | すでに存在します |
Property Details
メールダイジェスト
電子メールダイジェストのペイロードの詳細。
プロパティ名 | タイプ | 説明と有効な値 | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | 整数 | これはシステムによって自動生成され、応答で返されます。 これは | ||||||||||||||||||||||||||
| string 最小長:1 | 電子メールダイジェストの名前。 | ||||||||||||||||||||||||||
enabled | boolean デフォルト値: | 電子メールダイジェストを有効/無効の状態に設定します。 | ||||||||||||||||||||||||||
frequency | 整数 最小値:1 最大値:168 | イベントへの応答として電子メールが送信される頻度(時間単位)。 | ||||||||||||||||||||||||||
| minItems: 1 | 操作イベントがトリガーされたときに実行されるイベントへの事前定義済み、再利用可能、および自動応答について説明します。
| ||||||||||||||||||||||||||
events* | イベント電子メールダイジェストをトリガーするイベントについて説明します。
| |||||||||||||||||||||||||||
selectedEntities | SelectedEntityType電子メールダイジェストの対象になるエンティティの範囲。 EUM アプリケーションに対応するエンティティはサポートされていません。
|
SelectedEntityType
電子メールダイジェストの対象になるエンティティの範囲。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
SelectedEntityType* | string | Enums
|
SpecificEntities
電子メールダイジェストの対象になる特定のエンティティの範囲。
| プロパティ名 | タイプ | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
selectedEntityType* | string | 列挙体
| ||||||
entities | minItems: 1 | エンティティ
|
エンティティ
| プロパティ名 | タイプ | 説明 |
|---|---|---|
entityType* | string minItems: 1 | Enums
|
AnyEntity
電子メールダイジェストの対象になるエンティティの範囲。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
SelectedEntityType* | string | Enums
|
SelectedMobileApps
| プロパティ名 | タイプ | 説明 |
|---|---|---|
mobileAppsScope* | string | Enums
|
AllMobileApps
| プロパティ名 | タイプ | 説明 |
|---|---|---|
mobileAppsScope* | string | 列挙体
|
SpecificMobileApps
| プロパティ名 | タイプ | 説明 |
|---|---|---|
mobileAppsScope* | string | 列挙体
|
mobileApps | string minItems: 1 |
MobileAppsMatchingPattern
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
mobileAppsScope* | string | 列挙体MOBILE_APPS_MATCHING_PATTERN | ||||||||||||
patternMatcher* | EntityMatchingPattern指定されたパターンに一致するビジネストランザクションが範囲に含まれます。
|
MobileNetworkRequests
| プロパティ名 | タイプ | 説明 |
|---|---|---|
entityType* | string minItems: 1 | 列挙体
|
selectedMobileNetworkRequests* | string | MobileNetworkRequestsScopeEnums
|
SelectedMobileNetworkRequests
| プロパティ名 | タイプ | 説明 |
|---|---|---|
mobileNetworkRequestsScope* | string | MobileNetworkRequestsScopeEnums
|
AllMobileNetworkRequests
モバイルネットワーク要求の範囲は ALL_MOBILE_NETWORK_REQUESTS です。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
mobileNetworkRequestsScope* | string | MobileNetworkRequestsScope列挙体
|
SpecificMobileNetworkRequests
モバイルネットワーク要求の範囲は SPECIFIC_MOBILE_NETWORK_REQUESTS です。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
mobileNetworkRequestsScope* | string | MobileNetworkRequestsScope列挙体
|
mobileNetworkRequests* | string minItems:1 |
SpecificMobileAppsNetworkRequests
モバイルネットワーク要求の範囲は SPECIFIC_MOBILE_APPS_NETWORK_REQUESTS です。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
mobileNetworkRequestsScope* | string | MobileNetworkRequestsScope列挙体
|
mobileApps* | string minItems:1 |
MobileNetworkRequestsMatchingPattern
モバイルネットワーク要求の範囲は MOBILE_NETWORK_REQUESTS_MATCHING_PATTERN です。
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
mobileNetworkRequestsScope* | string | MobileNetworkRequestsScope列挙体
| ||||||||||||
patternMatcher* | EntityMatchingPattern指定されたパターンに一致するビジネストランザクションが範囲に含まれます。
|
ページ
電子メールダイジェストの対象になるエンティティの範囲が、EUM アプリケーションの page になります。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
entityType* | string minItems: 1 | 列挙体
|
selectedPages* | string | pageScopeEnums
|
SelectedPages
電子メールダイジェストの対象になるエンティティの範囲が、EUM アプリケーションの selected pages になります。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
pageScope* | string | Enums
|
AllPages
電子メールダイジェストの対象になるエンティティの範囲が、EUM アプリケーションの ALL_PAGES になります。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
pageScope* | string | 列挙体
|
SpecificPages
電子メールダイジェストの対象になるエンティティの範囲が、EUM アプリケーションの SPECIFIC_PAGES になります。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
pageScope* | string | 列挙体
|
pages* | 文字列の配列 minItems: 1 |
PagesMatchingPattern
電子メールダイジェストの対象になるエンティティの範囲が、EUM アプリケーションの SPECIFIC_PAGES になります。
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
pageScope* | string | 列挙体
| ||||||||||||
pages* | EntityMatchingPattern指定されたパターンに一致するビジネストランザクションが範囲に含まれます。
|
VirtualPage
| プロパティ名 | タイプ | 説明 |
|---|---|---|
entityType* | string minItems: 1 | 列挙体
|
| string | SelectedVirtualPagesEnums
|
SelectedVirtualPages
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | SelectedVirtualPagesEnums
|
AllVirtualPages
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | SelectedVirtualPages列挙体
|
SpecificVirtualPages
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | SelectedVirtualPages列挙体
|
virtualPages | string minItems: 1 |
VirtualPagesMatchingPattern
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | SelectedVirtualPages列挙体
| ||||||||||||
patternMatcher | EntityMatchingPattern指定されたパターンに一致するビジネストランザクションが範囲に含まれます。
|
SyntheticJob
| プロパティ名 | タイプ | 説明 |
|---|---|---|
entityType* | string minItems: 1 | 列挙体
|
selectedSyntheticJobs* | string | SelectedSyntheticJobsEnums
|
SelectedSyntheticJobs
| プロパティ名 | タイプ | 説明 |
|---|---|---|
syntheticJobScope* | string | Enums
|
AllSyntheticJobs
| プロパティ名 | タイプ | 説明 |
|---|---|---|
syntheticJobScope* | string | 列挙体
|
SpecificSyntheticJobs
| プロパティ名 | タイプ | 説明 |
|---|---|---|
syntheticJobScope* | string | 列挙体
|
syntheticJobs* | string minItems: 1 |
SyntheticJobsMatchingPattern
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
syntheticJobScope* | string | 列挙体
| ||||||||||||
patternMatcher* | EntityMatchingPattern指定されたパターンに一致するビジネストランザクションが範囲に含まれます。
|
IFrame
| プロパティ名 | タイプ | 説明 |
|---|---|---|
entityType* | string minItems: 1 | 列挙体IFRAME |
selectedIFrames* | string | iFrameScopeEnums
|
SelectedIFrames
| プロパティ名 | タイプ | 説明 |
|---|---|---|
iFrameScope* | string | Enums
|
AllIFrames
| プロパティ名 | タイプ | 説明 |
|---|---|---|
iFrameScope* | string | 列挙体
|
SpecificIFrames
| プロパティ名 | タイプ | 説明 |
|---|---|---|
iFrameScope* | string | 列挙体
|
iFrames* | string minItems: 1 |
IFramesMatchingPattern
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
iFrameScope* | string | 列挙体
| ||||||||||||
patternMatcher* | EntityMatchingPattern指定されたパターンに一致するビジネストランザクションが範囲に含まれます。
|
AjaxRequest
| プロパティ名 | タイプ | 説明 |
|---|---|---|
entityType* | string minItems: 1 | 列挙体
|
selectedAjaxRequests* | string | AjaxRequestsScopeEnums
|
SelectedAjaxRequests
| プロパティ名 | タイプ | 説明 |
|---|---|---|
selectedAjaxRequests* | string | Enums
|
AllAjaxRequests
| プロパティ名 | タイプ | 説明 |
|---|---|---|
selectedAjaxRequests* | string | 列挙体
|
SpecificAjaxRequests
| プロパティ名 | タイプ | 説明 |
|---|---|---|
selectedAjaxRequests* | string | 列挙体
|
ajaxRequests* | 文字列の配列 minItems: 1 |
AjaxRequestsMatchingPattern
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ajaxRequestScope* | string | 列挙体
| ||||||||||||
patternMatcher* | EntityMatchingPattern指定されたパターンに一致するビジネストランザクションが範囲に含まれます。
|
BusinessTransaction
タイプ BUSINESS_TRANSACTION のすべてのエンティティが、電子メールダイジェストの対象になります。
| プロパティ名 | タイプ | 説明 | ||||
|---|---|---|---|---|---|---|
entityType* | string | 列挙体BUSINESS_TRANSACTION | ||||
selectedBusinessTransactions* | string | BusinessTransactionScope
|
SelectedBusinessTransactions
| プロパティ名 | 説明 |
|---|---|
businessTransactionScope* | Enums
|
AllBusinessTransactions
ビジネストランザクションの範囲が、すべてのビジネストランザクションに設定されます。
| プロパティ名 | 説明 |
|---|---|
businessTransactionScope* | 列挙体
|
SpecificBusinessTransactions
ビジネストランザクションの範囲が、選択したビジネストランザクションに設定されます。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
businessTransactionScope* | string | 列挙体
|
businessTransactions* | 文字列の配列 minItems: 1 | ビジネストランザクションの名前。 |
BusinessTransactionsInSpecificTiers
ビジネストランザクションの範囲が、特定の階層に関連付けられたビジネストランザクションに設定されます。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
businessTransactionScope* | 列挙体
| |
specificTiers* | string minItems: 1 | 指定される階層の名前。 |
BusinessTransactionsMatchingPattern
ビジネストランザクションの範囲が、特定のパターンに一致するビジネストランザクションに設定されます。
| プロパティ名 | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
businessTransactionScope* | 列挙体
| ||||||||||||
patternMatcher* | EntityMatchingPattern指定されたパターンに一致するビジネストランザクションが範囲に含まれます。
|
SelectedTierOrNodeEntities
特定の階層またはノードが、電子メールダイジェストの対象になります。
| プロパティ名 | タイプ | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
entityType* | string | 列挙体TIER_NODE | ||||||
tierOrNode* | string minLength: 1 | TierOrNode
|
TierOrNode
| プロパティ名 | タイプ | 説明 |
|---|---|---|
tierOrNodeScope* | string | Enums
|
TierSelectedEntities
| プロパティ名 | タイプ | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
tierOrNodeScope* | string | Enums
| ||||||
selectedTiers* | SelectedTiers
|
SelectedTiers
| プロパティ名 | タイプ | 説明 |
|---|---|---|
selectedTierScope* | string | Enums
|
AllTiers
| プロパティ名 | タイプ | 説明 |
|---|---|---|
selectedTierScope* | string | 列挙体
|
SpecificTiers
| プロパティ名 | タイプ | 説明 |
|---|---|---|
selectedTierScope* | string | 列挙体
|
tiers* | string minItems: 1 | 指定される階層の名前。 |
NodeSelectedEntities
| プロパティ名 | タイプ | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
tierOrNodeScope* | string | 列挙体NODE_SELECTED_ENTITIES | ||||||
typeofNode* | string | EnumsALL_NODES JAVA_NODES DOT_NET_NODES PHP_NODES | ||||||
selectedNodes* | SelectedNodes
|
SelectedNodes
| プロパティ名 | タイプ | 説明 |
|---|---|---|
selectedNodeScope* | string | Enums
|
AllNodes
| プロパティ名 | タイプ | 説明 |
|---|---|---|
selectedNodeScope* | string | 列挙体
|
SpecificNodes
| プロパティ名 | タイプ | 説明 |
|---|---|---|
selectedNodeScope* | string | 列挙体
|
nodes* | string minItems: 1 | 指定されるノードの名前。 |
NodesOfSpecificTiers
| プロパティ名 | タイプ | 説明 |
|---|---|---|
selectedNodeScope* | string | 列挙体
|
specificTiers* | string minItems: 1 | 関連付けられたノードを持つ階層の名前。 |
NodesMatchingPattern
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
selectedNodeScope* | string | 列挙体
| ||||||||||||
patternMatcher* | EntityMatchingPattern指定されたパターンに一致するノードが範囲に含まれます。
|
NodePropertyVariableMatcher
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
selectedNodeScope* | string | 列挙体
| ||||||||||||
propVarPairs* | minItems: 1 | propVarPairs
|
エラー(Errors)
特定のエラーが電子メールダイジェストの対象になります。
| プロパティ名 | タイプ | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
entityType* | string | 列挙体
| ||||||
selectedErrors* | SelectedErrors
|
SelectedErrors
| プロパティ名 | タイプ | 説明 |
|---|---|---|
errorScope* | string | Enums
|
AllErrors
| プロパティ名 | タイプ | 説明 |
|---|---|---|
errorScope* | string | 列挙体
|
SpecificErrors
| プロパティ名 | タイプ | 説明 |
|---|---|---|
errorScope* | string | 列挙体
|
errors* | string minItems: 1 例: |
ErrorsOfSpecificTiers
| プロパティ名 | タイプ | 説明 |
|---|---|---|
errorScope* | string | 列挙体
|
specificTiers* | string minItems: 1 |
ErrorsMatchingPattern
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorScope* | string | 列挙体ERRORS_MATCHING_PATTERN | ||||||||||||
patternMatcher* | EntityMatchingPattern
|
ServiceEndpoints
特定のサービスエンドポイントが電子メールダイジェストの対象になります。
| プロパティ名 | タイプ | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
entityType* | string | 列挙体
| ||||||
selectedServiceEndpoints* | SelectedServiceEndpoints
|
SelectedServiceEndpoints
| プロパティ名 | タイプ | 説明 |
|---|---|---|
serviceEndpointScope* | string | Enums
|
AllServiceEndpoints
| プロパティ名 | タイプ | 説明 |
|---|---|---|
serviceEndpointScope* | string | Enums
|
SpecificServiceEndpoints
| プロパティ名 | タイプ | 説明 |
|---|---|---|
serviceEndpointScope* | string | 列挙体
|
serviceEndpoints* | string minItems: 1 |
ServiceEndpointsInSpecificTiers
| プロパティ名 | タイプ | 説明 |
|---|---|---|
serviceEndpointScope* | string | 列挙体
|
specificTiers* | string minItems: 1 |
ServiceEndpointsMatchingPattern
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
serviceEndpointScope* | string | 列挙体
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
InformationPoints
特定の情報ポイントが電子メールダイジェストの対象になります。
| プロパティ名 | タイプ | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
entityType* | string | 列挙体INFORMATION_POINTS | ||||||
selectedInformationPoints* | SelectedInformationPoints
|
SelectedInformationPoints
| プロパティ名 | タイプ | 説明 |
|---|---|---|
informationPointScope* | string | Enums
|
AllInformationPoints
| プロパティ名 | タイプ | 説明 |
|---|---|---|
informationPointScope* | string | Enums
|
SpecificInformationPoints
| プロパティ名 | タイプ | 説明 |
|---|---|---|
informationPointScope* | string | 列挙体
|
informationPoints* | string minItems: 1 |
InformationPointsMatchingPattern
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
informationPointScope* | string | 列挙体
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
DatabasesInApplication
アプリケーションに関連付けられている特定のデータベースが、電子メールダイジェストの対象になります。
| プロパティ名 | タイプ | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
| ||||||
selectedApplicationDatabases* | SelectedApplicationDatabases
|
SelectedApplicationDatabases
| プロパティ名 | タイプ | 説明 |
|---|---|---|
applicationDatabaseScope* | string | Enums
|
AllApplicationDatabases
| プロパティ名 | タイプ | 説明 |
|---|---|---|
applicationDatabaseScope* | string | 列挙体
|
SpecificApplicationDatabases
| プロパティ名 | タイプ | 説明 |
|---|---|---|
applicationDatabaseScope* | string | 列挙体
|
applicationDatabases* | string minItems: 1 |
ApplicationDatabasesMatchingPattern
| プロパティ名 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
applicationDatabaseScope* | string | 列挙体
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
ServersInApplication
アプリケーションに関連付けられている特定のサーバが、電子メールダイジェストの対象になります。
| プロパティ名 | タイプ | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
entityType* | string | 列挙体
| ||||||
selectedServers* | string | ApplicationSelectedServers
|
ApplicationSelectedServers
| プロパティ名 | タイプ | 説明 |
|---|---|---|
serversScope* | string | Enums
|
AllServersInApplication
| プロパティ名 | タイプ | 説明 |
|---|---|---|
serversScope* | string | 列挙体
|
SpecificServersInApplication
| プロパティ名 | タイプ | 説明 |
|---|---|---|
serversScope* | string | 列挙体
|
specificServers* | string minLength: 1 minItems: 1 |
AllServersInSpecificTiers
| プロパティ名 | タイプ | 説明 |
|---|---|---|
serversScope* | string | 列挙体
|
specificTiers* | string minItems: 1 |
イベント
電子メールダイジェストの対象になるさまざまなタイプのイベント。
| プロパティ名 | タイプ | 説明 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
healthRuleEvents | HealthRuleEvent電子メールダイジェストをトリガーする正常性ルールに関連付けられているイベント。
| |||||||||||||||||||
otherEvents | string | OtherEventTypeEnums
| ||||||||||||||||||
anomalyEvents | minItems: 1 | 異常検知によってトリガーされたイベント。 AnomalyEventTypeEnums
| ||||||||||||||||||
customEvents | 電子メールダイジェストをトリガーするカスタム定義イベント。 CustomEvent
|
CustomEvent
電子メールダイジェストの対象になるカスタム定義イベントの詳細。
| プロパティ名 | タイプ | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
eventName* | string | |||||||
PropertyMatchCriteria | 文字列 デフォルト: | Enums
| ||||||
keyValuePairArray | KeyValuePair
|
HealthRuleEvent
電子メールダイジェストの対象になる正常性ルールに関連付けられているイベント。
| プロパティ名 | タイプ | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
healthRuleEventTypes* | string minItems: 1 | HealthRuleEventTypeEnums
| ||||||
healthRuleScope* | string | 電子メールダイジェストをトリガーする特定の正常性ルールまたはすべての正常性ルールに関連付けられているイベント。 healthRuleScopeType
|
HealthRuleScope
電子メールダイジェストの対象になる特定の正常性ルールまたはすべての正常性ルールに関連付けられているイベント。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
healthRuleScopeType* | string | Enums
|
AllHealthRules
電子メールダイジェストの対象になるアプリケーション内のすべての正常性ルールに関連付けられているイベント。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
healthRuleScopeType* | string | 列挙体
|
SpecificHealthRules
電子メールダイジェストの対象になるアプリケーション内の特定の正常性ルールに関連付けられているイベント。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
healthRuleScopeType* | string | 列挙体
|
healthRules* | string minItems: 1 |
HealthRuleEventTypes
| プロパティ名 | タイプ | 説明 |
|---|---|---|
healthRuleEventTypes* | string | Enums
|
OtherEvents
| プロパティ名 | タイプ | 説明 |
|---|---|---|
otherEvents | string | OtherEventTypeEnums
|
AnomalyEvents
電子メールダイジェストの対象になる異常検知によって生成されたイベント。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
anomalyEvents | string minItems: 1 | AnomalyEventTypeEnums
|
操作
イベントに対する応答として実行されるアクションのリスト。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
actionName* | string | |
actionType* | string | ActionTypeEnums
|
SimpleActionType
ポリシーがトリガーされたときに実行される単純なアクション。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
actionName* | string | |
actionType* | string | ActionTypeEnums
|
EmailActionType
ポリシーがトリガーされると、電子メールが送信されます。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
actionName* | string | |
actionType* | string | ActionTypeEnums
|
notes | string |
ActionOnSpecifiedEntities
ポリシーがトリガーされたときに特定のエンティティに対して実行される単純なアクション。
| プロパティ名 | タイプ | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
actionName* | string | |||||||
actionType* | string | ActionTypeEnums
| ||||||
specifiedEntityActionDetails* | string | SpecifiedEntityActionDetails
|
SpecifiedEntityActionDetails
| プロパティ名 | タイプ | 説明 |
|---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScopeEnums
|
ActionOnPercentageEntities
アクションが実行されるエンティティの範囲が、percentage に設定されます。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScope列挙体
|
value* | 整数 |
ActionOnAbsoluteEntities
アクションが実行されるエンティティの範囲が、absolute に設定されます。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScope列挙体
|
value* | 整数 |
ActionOnSpecificNodes
アクションが実行されるノードのリスト。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScope列挙体
|
nodes* | string minItems: 1 |
EmailDigestSummaryArray
| プロパティ名 | タイプ |
|---|---|
id* | 整数 |
name* | 文字列 minLength: 1 |
enabled* | boolean |
KeyValuePair
| プロパティ名 | タイプ |
|---|---|
key* | string |
value* | 文字列 |
EmailDigestSummary
| プロパティ名 | タイプ |
|---|---|
id* | 整数 |
name* | 文字列 minLength: 1 |
enabled* | boolean |
EmailDigestConfiguration
| プロパティ名 | タイプ |
|---|---|
enabled* | boolean |
EmailDigestName | string |
frequency | 整数 最小値:1 最大値:168 |
EntityMatchingPattern
指定されたパターンに一致するエンティティ。
| プロパティ名 | タイプ | 説明 |
|---|---|---|
matchTo* | string | Enums
ENDS_WITH CONTAINS EQUALS MATCH_REG_EX |
matchValue* | string minLength: 1 | |
shouldNot | boolean デフォルト: |
Enums
PropertyMatchCriteria
| プロパティ名 | タイプ | 説明 |
|---|---|---|
propertyMatchCriteria | string デフォルト:ANY | Enums
|
EntityMatchingPatternEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
EntityMatchingPatternEnum | string | Enums
|
PageScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | Enums
|
VirtualPageScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | Enums
|
AjaxRequestScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | Enums
|
AjaxRequestScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | Enums
|
SyntheticJobScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | Enums
|
IFrameScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | Enums
|
BusinessTransactionScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
businessTransactionScope | string | Enums
|
MobileAppsScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | Enums
|
MobileNetworkRequestsScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
MobileAppsScopeEnum | string | Enums
|
TierOrNodeScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | Enums
|
SelectedTierScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | Enums
|
TypeOfNodeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
typeofNode | string | Enums
|
SelectedNodesScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
selectedNodeScope | string | Enums
|
NodePropertyTypeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| string | Enums
|
ErrorScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
ErrorScopeEnum | string | Enums
|
ServiceEndpointScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
ServiceEndpointScopeEnum | string | Enums
|
InformationPointScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
InformationPointScopeEnum | string |
|
DatabaseTypeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
DatabaseTypeEnum | string |
|
ApplicationDatabaseScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
ApplicationDatabaseScopeEnum | string |
|
ServersScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
ServersScopeEnum | string |
|
SpecifiedEntityActionScopeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
SpecifiedEntityActionScopeEnum | string |
|
AnomalyEventType
| プロパティ名 | タイプ | 説明 |
|---|---|---|
AnomalyEventType | string | Enums
|
HealthRuleEventTypeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
HealthRuleEventTypeEnum | string | Enums
|
HealthRuleScopeType
| プロパティ名 | タイプ | 説明 |
|---|---|---|
HealthRuleScopeType | string |
|
OtherEventType
| プロパティ名 | タイプ | 説明 |
|---|---|---|
OtherEventType | string | Enums
|
SelectedEntityType
| プロパティ名 | タイプ | 説明 |
|---|---|---|
SelectedEntityType | string |
|
EntityType
| プロパティ名 | タイプ | 説明 |
|---|---|---|
EntityType | string | Enums
|
ActionTypeEnum
| プロパティ名 | タイプ | 説明 |
|---|---|---|
ActionTypeEnum | string |
|
ErrorResponse
| プロパティ名 | タイプ |
|---|---|
statusCode | 整数 |
message | 文字列 |
*This property is required.
例のダウンロード
Appdynamics Email Digest Examples.zip をダウンロードして、電子メールダイジェストを設定するのに役立つ一連の例を取得します。
SWAGGER YAML ファイルのダウンロード
Swagger email_digests_openapi.yml ファイルをダウンロードします。