Download PDF
Download page ポリシー API.
ポリシー API
このページでは、アプリケーションのポリシーを作成、設定、および管理するために使用できる、ポリシー API メソッドについて説明します。
ポリシーは、1 つ以上のイベントを基準とするトリガーと、そのトリガーに応じるアクションとで構成されます。ポリシーは、モニタリング、アラート、問題の修復を自動化するために使用します。
- JSON ペイロードの構文検証は、ポリシーの作成時に実行されます。
- EUM アプリケーションに対応するオブジェクトやエンティティはサポートされていません。
ポリシーの作成
指定された JSON ペイロードを使用して新しいポリシーを作成します。
リソースURL
POST <controller_url>/controller/alerting/rest
/v1/applications/<application_id>/policies
要求/応答の形式
JSON
例
{
"name": "Policy json create example",
"enabled": true,
"executeActionsInBatch": true,
"actions": [
{
"actionName": "your@email.com",
"actionType": "EMAIL",
"notes": "example notes"
},
{
"actionName": "Thread dump action",
"actionType": "THREAD_DUMP",
"specifiedEntityActionDetails": {
"specifiedEntityActionScope": "SPECIFIC_NODES",
"nodes": [
"node1"
]
}
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_OPEN_CRITICAL",
"HEALTH_RULE_UPGRADED",
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_CONTINUES_WARNING"
],
"healthRuleScope": {
"healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
"healthRules": [
"JVM Garbage Collection Time is too high",
"Memory utilization is too high"
]
}
},
"otherEvents": [
"VERY_SLOW",
"STALL",
"SLOW",
"ERROR"
]
},
"selectedEntities": {
"selectedEntityType": "SPECIFIC_ENTITIES",
"entities": [
{
"entityType": "BUSINESS_TRANSACTION",
"selectedBusinessTransactions": {
"businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
"businessTransactions": [
"/home/auctions"
]
}
},
{
"entityType": "TIER_NODE",
"tierOrNode": {
"tierOrNodeScope": "NODE_SELECTED_ENTITIES",
"typeofNode": "ALL_NODES",
"selectedNodes": {
"selectedNodeScope": "SPECIFIC_NODES",
"nodes": [
"node1"
]
}
}
}
]
}
}
{
"id": 2,
"name": "Policy json create example",
"enabled": true,
"executeActionsInBatch": true,
"actions": [
{
"actionName": "your@email.com",
"actionType": "EMAIL",
"notes": "example notes"
},
{
"actionName": "Thread dump action",
"actionType": "THREAD_DUMP",
"specifiedEntityActionDetails": {
"specifiedEntityActionScope": "SPECIFIC_NODES",
"nodes": [
"node1"
]
}
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_OPEN_CRITICAL",
"HEALTH_RULE_UPGRADED",
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_CONTINUES_WARNING"
],
"healthRuleScope": {
"healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
"healthRules": [
"JVM Garbage Collection Time is too high",
"Memory utilization is too high"
]
}
},
"otherEvents": [
"VERY_SLOW",
"SLOW",
"ERROR",
"STALL"
],
"anomalyEvents": null,
"customEvents": []
},
"selectedEntities": {
"selectedEntityType": "SPECIFIC_ENTITIES",
"entities": [
{
"entityType": "BUSINESS_TRANSACTION",
"selectedBusinessTransactions": {
"businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
"businessTransactions": [
"/home/auctions"
]
}
},
{
"entityType": "TIER_NODE",
"tierOrNode": {
"tierOrNodeScope": "NODE_SELECTED_ENTITIES",
"typeofNode": "ALL_NODES",
"selectedNodes": {
"selectedNodeScope": "SPECIFIC_NODES",
"nodes": [
"node1"
]
}
}
}
]
}
}
アプリケーションに関連付けられているポリシーのリストの取得
この API は、指定されたアプリケーションに関連付けられているすべてのポリシー、ポリシー名、ID、および有効フラグの詳細を返します。ポリシーの完全な詳細を取得するには、GET /policies/{policy-id}
を使用します。
リソースURL
GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/policies
応答形式
JSON
応答の例
[
{
"id": 1,
"name": "Policy json update example",
"enabled": true
},
{
"id": 2,
"name": "Policy json create example",
"enabled": true
}
]
指定されたポリシーの詳細の取得
指定されたポリシー ID に対してポリシーの JSON
表現を返します。
リソースURL
GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/policies/{policy-id}
応答形式
JSON
応答の例
この例では、ポリシーの設定の詳細を取得します。
{
"id": 1,
"name": "Policy REST get json example",
"enabled": true,
"executeActionsInBatch": true,
"actions": [
{
"actionName": "your@email.com",
"actionType": "EMAIL",
"notes": "example notes"
},
{
"actionName": "1234567890",
"actionType": "SMS"
},
{
"actionName": "Thread dump action",
"actionType": "THREAD_DUMP",
"specifiedEntityActionDetails": {
"specifiedEntityActionScope": "SPECIFIC_NODES",
"nodes": [
"node1"
]
}
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_OPEN_CRITICAL",
"HEALTH_RULE_UPGRADED",
"HEALTH_RULE_CONTINUES_CRITICAL",
"HEALTH_RULE_CONTINUES_WARNING"
],
"healthRuleScope": {
"healthRuleScopeType": "SPECIFIC_HEALTH_RULES",
"healthRules": [
"JVM Garbage Collection Time is too high",
"Memory utilization is too high"
]
}
},
"otherEvents": [
"VERY_SLOW",
"STALL",
"SLOW",
"ERROR"
],
"anomalyEvents": null,
"customEvents": []
},
"selectedEntities": {
"selectedEntityType": "SPECIFIC_ENTITIES",
"entities": [
{
"entityType": "BUSINESS_TRANSACTION",
"selectedBusinessTransactions": {
"businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
"businessTransactions": [
"/home/auctions"
]
}
},
{
"entityType": "TIER_NODE",
"tierOrNode": {
"tierOrNodeScope": "NODE_SELECTED_ENTITIES",
"typeofNode": "ALL_NODES",
"selectedNodes": {
"selectedNodeScope": "SPECIFIC_NODES",
"nodes": [
"node1"
]
}
}
}
]
}
}
ポリシーの更新
既存のポリシーの構成設定を、指定されたポリシー ID の値で更新します。
この要求には、入力として完全な JSON ペイロードが必要です。AppDynamics の推奨事項
GET /policies/{policy-id}
を使用して JSON ペイロードを取得し、必要なフィールドを更新します。- 変更したペイロードを
PUT
要求の一部として送信します。
リソースURL
PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/policies/{policy-id}
要求/応答の形式
JSON
例
{
"name": "Policy json update example",
"enabled": true,
"executeActionsInBatch": true,
"actions": [
{
"actionName": "Thread dump action",
"actionType": "THREAD_DUMP",
"specifiedEntityActionDetails": {
"specifiedEntityActionScope": "SPECIFIC_NODES",
"nodes": [
"node1"
]
}
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_OPEN_CRITICAL",
"HEALTH_RULE_UPGRADED",
"HEALTH_RULE_CONTINUES_CRITICAL"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"VERY_SLOW",
"STALL",
"SLOW",
"ERROR"
]
},
"selectedEntities": {
"selectedEntityType": "SPECIFIC_ENTITIES",
"entities": [
{
"entityType": "BUSINESS_TRANSACTION",
"selectedBusinessTransactions": {
"businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
"businessTransactions": [
"/home/auctions"
]
}
},
{
"entityType": "TIER_NODE",
"tierOrNode": {
"tierOrNodeScope": "NODE_SELECTED_ENTITIES",
"typeofNode": "ALL_NODES",
"selectedNodes": {
"selectedNodeScope": "SPECIFIC_NODES",
"nodes": [
"node1"
]
}
}
}
]
}
}
{
"id": 1,
"name": "Policy json update example",
"enabled": true,
"executeActionsInBatch": true,
"actions": [
{
"actionName": "Thread dump action",
"actionType": "THREAD_DUMP",
"specifiedEntityActionDetails": {
"specifiedEntityActionScope": "SPECIFIC_NODES",
"nodes": [
"node1"
]
}
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_OPEN_CRITICAL",
"HEALTH_RULE_UPGRADED",
"HEALTH_RULE_CONTINUES_CRITICAL"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"VERY_SLOW",
"SLOW",
"ERROR",
"STALL"
],
"anomalyEvents": null,
"customEvents": []
},
"selectedEntities": {
"selectedEntityType": "SPECIFIC_ENTITIES",
"entities": [
{
"entityType": "BUSINESS_TRANSACTION",
"selectedBusinessTransactions": {
"businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
"businessTransactions": [
"/home/auctions"
]
}
},
{
"entityType": "TIER_NODE",
"tierOrNode": {
"tierOrNodeScope": "NODE_SELECTED_ENTITIES",
"typeofNode": "ALL_NODES",
"selectedNodes": {
"selectedNodeScope": "SPECIFIC_NODES",
"nodes": [
"node1"
]
}
}
}
]
}
}
ポリシーの削除
指定された ID を持つ既存のポリシーを削除します。
有効な既存のポリシー ID が指定されていることを確認してください。
リソースURL
DELETE <controller_url>/controller/alerting/rest/v1/applications/<application_id>/policies/{policy-id}
ポリシー構成の更新
ポリシーの 1 つ以上の特定の構成設定を更新します。この API を使用して、Name フィールドと Enabled フィールドを更新できます。
リソースURL
PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/policies/{policy-id}/configuration
要求/応答の形式
JSON
例
{
"name": "Policy json update example",
"enabled": false
}
{
"id": 1,
"name": "Policy json update example",
"enabled": false,
"executeActionsInBatch": true,
"actions": [
{
"actionName": "Thread dump action",
"actionType": "THREAD_DUMP",
"specifiedEntityActionDetails": {
"specifiedEntityActionScope": "SPECIFIC_NODES",
"nodes": [
"node1"
]
}
}
],
"events": {
"healthRuleEvents": {
"healthRuleEventTypes": [
"HEALTH_RULE_OPEN_CRITICAL",
"HEALTH_RULE_UPGRADED",
"HEALTH_RULE_CONTINUES_CRITICAL"
],
"healthRuleScope": {
"healthRuleScopeType": "ALL_HEALTH_RULES"
}
},
"otherEvents": [
"VERY_SLOW",
"STALL",
"SLOW",
"ERROR"
],
"anomalyEvents": null,
"customEvents": []
},
"selectedEntities": {
"selectedEntityType": "SPECIFIC_ENTITIES",
"entities": [
{
"entityType": "BUSINESS_TRANSACTION",
"selectedBusinessTransactions": {
"businessTransactionScope": "SPECIFIC_BUSINESS_TRANSACTIONS",
"businessTransactions": [
"/home/auctions"
]
}
},
{
"entityType": "TIER_NODE",
"tierOrNode": {
"tierOrNodeScope": "NODE_SELECTED_ENTITIES",
"typeofNode": "ALL_NODES",
"selectedNodes": {
"selectedNodeScope": "SPECIFIC_NODES",
"nodes": [
"node1"
]
}
}
}
]
}
}
応答の例
応答コード
コード | 説明 |
---|---|
200 | 正常に取得されました |
201 | 正常に作成されました |
204 | 正常に削除されました |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
404 | リソースが見つかりません |
409 | すでに存在します |
Property Details
ポリシー
ポリシーのペイロードの詳細。
プロパティ名 | タイプ | 説明と有効な値 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | 整数 | これはシステムによって自動生成され、応答で返されます。 これは | ||||||||||||||||||||||||
| string | ポリシーの名前です。 最小長:1 | ||||||||||||||||||||||||
enabled | boolean | ポリシーを有効/無効の状態に設定します。 デフォルト値: | ||||||||||||||||||||||||
| boolean | 過去 1 分間に発生したすべてのトリガーイベントに対して、ポリシーに構成されたアクションを 1 回実行します。 デフォルト値: | ||||||||||||||||||||||||
| minItems: 1 | 操作ポリシーがトリガーされたときに実行されるイベントへの事前定義済み、再利用可能、および自動応答について説明します。
| ||||||||||||||||||||||||
events* | イベントポリシーをトリガーするイベントについて説明します。
| |||||||||||||||||||||||||
selectedEntities | SelectedEntityTypeポリシー評価の対象となるエンティティの範囲。 EUM アプリケーションに対応するエンティティはサポートされていません。
|
SelectedEntityType
ポリシー評価の対象となるエンティティの範囲。
EUM アプリケーションに対応するエンティティはサポートされていません。
プロパティ名 | タイプ | 説明 |
---|---|---|
SelectedEntityType * | string | Enums
|
SpecificEntities
ポリシー評価の対象となる特定のエンティティの範囲。
プロパティ名 | タイプ | 説明 | ||||||
---|---|---|---|---|---|---|---|---|
selectedEntityType* | string | Enums
| ||||||
entities | minItems: 1 | エンティティ
|
エンティティ
プロパティ名 | タイプ | 説明 |
---|---|---|
entityType * | string minItems: 1 | Enums
|
AnyEntity
ポリシー評価の対象となるエンティティの範囲。
EUM アプリケーションに対応するエンティティはサポートされていません。
プロパティ名 | タイプ | 説明 |
---|---|---|
SelectedEntityType * | string | Enums
|
BusinessTransaction
タイプ BUSINESS_TRANSACTION
のすべてのエンティティが、ポリシー評価の対象になります。
プロパティ名 | タイプ | 説明 | ||||
---|---|---|---|---|---|---|
entityType* | string minItems: 1 | Enums
| ||||
selectedBusinessTransactions* | string | BusinessTransactionScope
|
SelectedBusinessTransactions
プロパティ名 | 説明 |
---|---|
businessTransactionScope * | Enums
|
AllBusinessTransactions
ビジネストランザクションの範囲が、すべてのビジネストランザクションに設定されます。
プロパティ名 | 説明 |
---|---|
businessTransactionScope * | Enums
|
SpecificBusinessTransactions
ビジネストランザクションの範囲が、選択したビジネストランザクションに設定されます。
プロパティ名 | タイプ | 説明 |
---|---|---|
businessTransactionScope* | Enums
| |
businessTransactions* | string minItems: 1 | ビジネストランザクションの名前。 |
BusinessTransactionsInSpecificTiers
ビジネストランザクションの範囲が、特定の階層に関連付けられたビジネストランザクションに設定されます。
プロパティ名 | タイプ | 説明 |
---|---|---|
businessTransactionScope* | Enums
| |
specificTiers* | string minItems: 1 | 指定される階層の名前。 |
BusinessTransactionsMatchingPattern
ビジネストランザクションの範囲が、特定のパターンに一致するビジネストランザクションに設定されます。
プロパティ名 | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
businessTransactionScope* | Enums
| ||||||||||||
patternMatcher* | EntityMatchingPattern指定されたパターンに一致するビジネストランザクションが範囲に含まれます。
|
SelectedTierOrNodeEntities
特定の階層またはノードがポリシー評価の対象になります。
プロパティ名 | タイプ | 説明 | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
TIER_NODE エラー SERVICE_ENDPOINTS INFORMATION_POINTS DATABASES_IN_APPLICATION SERVERS_IN_APPLICATION | ||||||
tierOrNode* | string minLength: 1 | TierOrNode
|
TierOrNode
プロパティ名 | タイプ | 説明 |
---|---|---|
tierOrNodeScope * | string | Enums
|
TierSelectedEntities
プロパティ名 | タイプ | 説明 | ||||||
---|---|---|---|---|---|---|---|---|
tierOrNodeScope* | string | Enums
| ||||||
selectedTiers* | SelectedTiers
|
SelectedTiers
プロパティ名 | タイプ | 説明 |
---|---|---|
selectedTierScope * | string | Enums
|
AllTiers
プロパティ名 | タイプ | 説明 |
---|---|---|
selectedTierScope * | string | Enums
|
SpecificTiers
プロパティ名 | タイプ | 説明 |
---|---|---|
selectedTierScope* | string | Enums
|
tiers* | string minItems: 1 | 指定される階層の名前。 |
NodeSelectedEntities
プロパティ名 | タイプ | 説明 | ||||||
---|---|---|---|---|---|---|---|---|
tierOrNodeScope* | string | Enums
| ||||||
typeofNode* | string | Enums
| ||||||
selectedNodes* | SelectedNodes
|
SelectedNodes
プロパティ名 | タイプ | 説明 |
---|---|---|
selectedNodeScope* | string | Enums
|
AllNodes
プロパティ名 | タイプ | 説明 |
---|---|---|
selectedNodeScope * | string | Enums
|
SpecificNodes
プロパティ名 | タイプ | 説明 |
---|---|---|
selectedNodeScope * | string | Enums
|
nodes * | string minItems: 1 | 指定されるノードの名前。 |
NodesOfSpecificTiers
プロパティ名 | タイプ | 説明 |
---|---|---|
selectedNodeScope * | string | Enums
|
specificTiers * | string minItems: 1 | 関連付けられたノードを持つ階層の名前。 |
NodesMatchingPattern
プロパティ名 | タイプ | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
selectedNodeScope* | string | Enums
| ||||||||||||
patternMatcher* | string minItems: 1 | EntityMatchingPattern指定されたパターンに一致するノードが範囲に含まれます。
|
NodePropertyVariableMatcher
プロパティ名 | タイプ | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
selectedNodeScope* | string | Enums
| ||||||||||||
propVarPairs* | minItems: 1 | propVarPairs
|
エラー(Errors)
特定のエラーがポリシー評価の対象になります。
プロパティ名 | タイプ | 説明 | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
| ||||||
selectedErrors* | SelectedErrors
|
SelectedErrors
プロパティ名 | タイプ | 説明 |
---|---|---|
errorScope * | string | Enums
|
AllErrors
プロパティ名 | タイプ | 説明 |
---|---|---|
errorScope * | string | Enums
|
SpecificErrors
プロパティ名 | タイプ | 説明 |
---|---|---|
errorScope* | string | Enums
|
errors* | string minItems: 1 例: |
ErrorsOfSpecificTiers
プロパティ名 | タイプ | 説明 |
---|---|---|
errorScope* | string | Enums
|
specificTiers* | string minItems: 1 |
ErrorsMatchingPattern
プロパティ名 | タイプ | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorScope* | string | Enums
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
ServiceEndpoints
特定のサービスエンドポイントがポリシー評価の対象になります。
プロパティ名 | タイプ | 説明 | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
| ||||||
selectedServiceEndpoints* | SelectedServiceEndpoints
|
SelectedServiceEndpoints
プロパティ名 | タイプ | 説明 |
---|---|---|
serviceEndpointScope* | string | Enums
|
AllServiceEndpoints
プロパティ名 | タイプ | 説明 |
---|---|---|
serviceEndpointScope * | string | Enums
|
SpecificServiceEndpoints
プロパティ名 | タイプ | 説明 |
---|---|---|
serviceEndpointScope* | string | Enums
|
serviceEndpoints* | string minItems: 1 |
ServiceEndpointsInSpecificTiers
プロパティ名 | タイプ | 説明 |
---|---|---|
serviceEndpointScope* | string | EnumsALL_SERVICE_ENDPOINTS SPECIFIC_SERVICE_ENDPOINTS SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS SERVICE_ENDPOINTS_MATCHING_PATTERN |
specificTiers* | string minItems: 1 |
ServiceEndpointsInSpecificTiers
プロパティ名 | タイプ | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
serviceEndpointScope* | string | EnumsALL_SERVICE_ENDPOINTS SPECIFIC_SERVICE_ENDPOINTS SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS SERVICE_ENDPOINTS_MATCHING_PATTERN | ||||||||||||
patternMatcher* | EntityMatchingPattern
|
InformationPoints
特定の情報ポイントがポリシー評価の対象になります。
プロパティ名 | タイプ | 説明 | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
| ||||||
selectedInformationPoints* | SelectedInformationPoints
|
SelectedInformationPoints
プロパティ名 | タイプ | 説明 |
---|---|---|
informationPointScope * | string | EnumsALL_INFORMATION_POINTS SPECIFIC_INFORMATION_POINTS INFORMATION_POINTS_MATCHING_PATTERN |
AllInformationPoints
プロパティ名 | タイプ | 説明 |
---|---|---|
informationPointScope * | string | Enums
|
SpecificInformationPoints
プロパティ名 | タイプ | 説明 |
---|---|---|
informationPointScope * | string | Enums
|
informationPoints* | string minItems: 1 |
InformationPointsMatchingPattern
プロパティ名 | タイプ | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
informationPointScope* | string | Enums
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
DatabasesInApplication
アプリケーションに関連付けられている特定のデータベースが、ポリシー評価の対象になります。
プロパティ名 | タイプ | 説明 | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
| ||||||
selectedApplicationDatabases* | SelectedApplicationDatabases
|
SelectedApplicationDatabases
プロパティ名 | タイプ | 説明 |
---|---|---|
applicationDatabaseScope* | string | Enums
|
AllApplicationDatabases
プロパティ名 | タイプ | 説明 |
---|---|---|
applicationDatabaseScope * | string | Enums
|
SpecificApplicationDatabases
プロパティ名 | タイプ | 説明 |
---|---|---|
applicationDatabaseScope* | string | Enums
|
applicationDatabases* | string minItems: 1 |
ApplicationDatabasesMatchingPattern
プロパティ名 | タイプ | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
applicationDatabaseScope* | string | Enums
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
ServersInApplication
アプリケーションに関連付けられている特定のサーバが、ポリシー評価の対象になります。
プロパティ名 | タイプ | 説明 | ||||||
---|---|---|---|---|---|---|---|---|
entityType* | string | Enums
| ||||||
selectedServers* | string | ApplicationSelectedServers
|
ApplicationSelectedServers
プロパティ名 | タイプ | 説明 |
---|---|---|
serversScope * | string | Enums
|
AllServersInApplication
プロパティ名 | タイプ | 説明 |
---|---|---|
serversScope * | string | Enums
|
SpecificServersInApplication
プロパティ名 | タイプ | 説明 |
---|---|---|
serversScope* | string | Enums
|
specificServers* | string minLength: 1 minItems: 1 |
AllServersInSpecificTiers
プロパティ名 | タイプ | 説明 |
---|---|---|
serversScope* | string | Enums
|
specificTiers* | string minItems: 1 |
イベント
ポリシーをトリガーするさまざまなタイプのイベント。
プロパティ名 | タイプ | 説明 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
healthRuleEvents | HealthRuleEventポリシーをトリガーする正常性ルールに関連付けられているイベント。
| |||||||||||||||||||
otherEvents | string | OtherEventTypeEnums
| ||||||||||||||||||
anomalyEvents | minItems: 1 | 異常検知によってトリガーされたイベント。 AnomalyEventTypeEnums
| ||||||||||||||||||
customEvents | ポリシーをトリガーするカスタム定義イベント。 CustomEvent
|
CustomEvent
ポリシーをトリガーするカスタム定義イベントの詳細。
プロパティ名 | タイプ | 説明 | ||||||
---|---|---|---|---|---|---|---|---|
eventName* | string | |||||||
PropertyMatchCriteria | string デフォルト:ANY | Enums
| ||||||
keyValuePairArray | KeyValuePair
|
HealthRuleEvent
ポリシーをトリガーする正常性ルールに関連付けられているイベント。
プロパティ名 | タイプ | 説明 | ||||||
---|---|---|---|---|---|---|---|---|
healthRuleEventTypes* | string minItems: 1 | HealthRuleEventTypeEnums
| ||||||
healthRuleScope* | string | ポリシーをトリガーする特定の正常性ルールまたはすべての正常性ルールに関連付けられているイベント。 healthRuleScopeType
|
HealthRuleScope
ポリシーをトリガーする特定の正常性ルールまたはすべての正常性ルールに関連付けられているイベント。
プロパティ名 | タイプ | 説明 |
---|---|---|
healthRuleScopeType* | string | Enums
|
AllHealthRules
アプリケーション内のすべての正常性ルールに関連付けられているイベントによって、ポリシーがトリガーされます。
プロパティ名 | タイプ | 説明 |
---|---|---|
healthRuleScopeType* | string | Enums
|
AllHealthRules
アプリケーション内の特定の正常性ルールに関連付けられているイベントによって、ポリシーがトリガーされます。
プロパティ名 | タイプ | 説明 |
---|---|---|
healthRuleScopeType* | string | Enums
|
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
アクションが実行されるエンティティの範囲が、「パーセンテージ」に設定されます。
プロパティ名 | タイプ | 説明 |
---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScopeEnums
|
value* | 整数 |
ActionOnPercentageEntities
アクションが実行されるエンティティの範囲が、absolute に設定されます。
プロパティ名 | タイプ | 説明 |
---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScopeEnums
|
value* | 整数 |
ActionOnPercentageEntities
アクションが実行されるノードのリスト。
プロパティ名 | タイプ | 説明 |
---|---|---|
specifiedEntityActionScope | string | SpecifiedEntityActionScopeEnums
|
nodes* | string minItems: 1 |
PolicySummaryArray
プロパティ名 | タイプ |
---|---|
id* | 整数 |
name* | 文字列 minLength: 1 |
enabled* | boolean |
KeyValuePair
プロパティ名 | タイプ |
---|---|
key* | string |
value* | string |
PolicySummary
プロパティ名 | タイプ |
---|---|
id* | 整数 |
name* | 文字列 minLength: 1 |
enabled* | boolean |
PolicyConfiguration
プロパティ名 | タイプ |
---|---|
enabled* | boolean |
policyName | string |
EntityMatchingPattern
指定されたパターンに一致するエンティティ。
プロパティ名 | タイプ | 説明 |
---|---|---|
matchTo* | string | Enums
|
matchValue* | string minLength: 1 | |
shouldNot | boolean デフォルト: |
ErrorResponse
プロパティ名 | タイプ |
---|---|
statusCode | 整数 |
message | 文字列 |
PropertyMatchCriteria
プロパティ名 | タイプ | 説明 |
---|---|---|
propertyMatchCriteria | string デフォルト:ANY | Enums
|
EntityMatchingPatternEnum
プロパティ名 | タイプ | 説明 |
---|---|---|
EntityMatchingPatternEnum | string | Enums
ENDS_WITH CONTAINS EQUALS MATCH_REG_EX |
BusinessTransactionScopeEnum
プロパティ名 | タイプ | 説明 |
---|---|---|
businessTransactionScope | 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 | Enums
|
ServersScopeEnum
プロパティ名 | タイプ | 説明 |
---|---|---|
ServersScopeEnum | string |
|
SpecifiedEntityActionScopeEnum
プロパティ名 | タイプ | 説明 |
---|---|---|
SpecifiedEntityActionScopeEnum | string | Enums
|
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 | Enums
|
*This property is required.
例のダウンロード
ポリシー AppDynamicsPoliciesExamples.zip
を設定するのに役立つ一連の例をダウンロードします。
SWAGGER YAML 仕様のダウンロード
Swagger YAML 仕様 policies_openapi.yml
をダウンロードします。