Download PDF
Download page 正常性ルール API.
正常性ルール API
Related pages:
このページでは、複数のアプリケーションの正常性ルールを同時に作成、構成、更新、および削除するために使用できる正常性ルール API メソッドについて説明します。この API を使用すると、1 つまたは複数の正常性ルールをプログラムで更新および保守したり、アプリケーション間やコントローラ間で移行したりすることができます。
- JSON ペイロードの最小構文検証は、正常性ルールの作成時に実行されます。
- 指定されたメトリックのパス検証は実行されません。定義したすべてのメトリックに対して有効なパスが提供されていることを確認します。
- 正常性ルールの評価中にメトリックが解決されない場合、正常性ルールは不明(?)状態になります。定義した影響を受けるすべてのエンティティに対して有効なメトリックが提供されていることを確認します。
正常性ルールの作成
指定された JSON ペイロードから新しい正常性ルールを作成します。「プロパティの詳細」を参照してください。
リソースURL
POST <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules
要求/応答の形式
JSON
例
この例では、影響を受けるエンティティタイプ business transaction performance
を含む正常性ルールを作成し、正常性ルールの評価基準を定義します。「例のダウンロード」を参照してください。
{
"name": "My new health rule",
"enabled": true,
"useDataFromLastNMinutes": 30,
"waitTimeAfterViolation": 5,
"affects": {
"affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
"affectedBusinessTransactions": {
"businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
}
},
"evalCriterias": {
"criticalCriteria": {
"conditionAggregationType": "ALL",
"conditions": [
{
"name": "Condition 1",
"shortName": "A",
"evaluateToTrueOnNoData": false,
"evalDetail": {
"evalDetailType": "SINGLE_METRIC",
"metricAggregateFunction": "VALUE",
"metricPath": "Average CPU Used (ms)",
"metricEvalDetail": {
"metricEvalDetailType": "BASELINE_TYPE",
"baselineCondition": "WITHIN_BASELINE",
"baselineName": "All Data - Last 15 Days",
"baselineUnit": "PERCENTAGE",
"compareValue": 30.5
}
}
}
]
},
"warningCriteria": {
"conditionAggregationType": "ALL",
"conditions": [
{
"name": "Condition 1",
"shortName": "A",
"evalDetail": {
"evalDetailType": "METRIC_EXPRESSION",
"metricExpression": "({metric1} + ({metric2} * 3))",
"metricExpressionVariables": [
{
"variableName": "metric1",
"metricAggregateFunction": "VALUE",
"metricPath": "95th Percentile Response Time (ms)"
},
{
"variableName": "metric2",
"metricAggregateFunction": "MAXIMUM",
"metricPath": "Average CPU Used (ms)"
}
],
"metricEvalDetail": {
"metricEvalDetailType": "SPECIFIC_TYPE",
"compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
"compareValue": 10
}
}
}
]
}
}
}
{
"id": 26,
"name": "My new health rule",
"enabled": false,
"useDataFromLastNMinutes": 30,
"waitTimeAfterViolation": 5,
"scheduleName": "Weeknights: 11pm-6am, Mon-Fri",
"affects": {
"affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
"affectedBusinessTransactions": {
"businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
}
},
"evalCriterias": {
"criticalCriteria": {
"conditionAggregationType": "ALL",
"conditionExpression": null,
"conditions": [
{
"name": "Condition 1",
"shortName": "A",
"evaluateToTrueOnNoData": false,
"evalDetail": {
"evalDetailType": "SINGLE_METRIC",
"metricAggregateFunction": "VALUE",
"metricPath": "Average CPU Used (ms)",
"metricEvalDetail": {
"metricEvalDetailType": "BASELINE_TYPE",
"baselineCondition": "WITHIN_BASELINE",
"baselineName": "All data - Last 15 days",
"compareValue": 30.5,
"baselineUnit": "PERCENTAGE"
}
},
"triggerEnabled": false,
"minimumTriggers": 0
}
],
"evalMatchingCriteria": {
"matchType": "ANY_NODE",
"value": null
}
},
"warningCriteria": {
"conditionAggregationType": "ALL",
"conditionExpression": null,
"conditions": [
{
"name": "Condition 1",
"shortName": "A",
"evaluateToTrueOnNoData": false,
"evalDetail": {
"evalDetailType": "METRIC_EXPRESSION",
"metricExpression": "({metric1} + ({metric2} * 3))",
"metricExpressionVariables": [
{
"variableName": "metric1",
"metricAggregateFunction": "VALUE",
"metricPath": "95th Percentile Response Time (ms)"
},
{
"variableName": "metric2",
"metricAggregateFunction": "MAXIMUM",
"metricPath": "Average CPU Used (ms)"
}
],
"metricEvalDetail": {
"metricEvalDetailType": "SPECIFIC_TYPE",
"compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
"compareValue": 10
}
},
"triggerEnabled": false,
"minimumTriggers": 0
}
],
"evalMatchingCriteria": {
"matchType": "ANY_NODE",
"value": null
}
}
}
}
アプリケーションの正常性ルールのリストの取得
この API は、指定されたアプリケーション ID に対して、すべての正常性ルール ID と名前のリストを返します。正常性ルールの完全な詳細を取得するには、GET //health-rule/{health-rule-id}
を使用します。「プロパティの詳細」を参照してください。
リソースURL
GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules
応答形式
JSON
応答の例
[
{
"id": 1,
"name": "Machine Availability is too low",
"enabled": true
},
{
"id": 2,
"name": "Overall Disk Space Available is too low",
"enabled": true
},
{
"id": 3,
"name": "CPU Usage is too high",
"enabled": true
},
{
"id": 4,
"name": "Memory Usage is too high",
"enabled": true
},
{
"id": 5,
"name": "Swap Usage is too high",
"enabled": true
},
{
"id": 6,
"name": "Disk Usage is too high on at least one partition",
"enabled": false
}
]
指定された正常性ルールの詳細の取得
この API は、指定された正常性ルール ID に対して正常性ルールの詳細を返します。
JMX 正常性ルールはサポートされていません。
リソースURL
GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/{health-rule-id}
応答形式
JSON
応答の例
{
"id": 26,
"name": "My new health rule",
"enabled": true,
"useDataFromLastNMinutes": 30,
"waitTimeAfterViolation": 5,
"scheduleName": "Always",
"affects": {
"affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
"affectedBusinessTransactions": {
"businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
}
},
"evalCriterias": {
"criticalCriteria": {
"conditionAggregationType": "ALL",
"conditionExpression": null,
"conditions": [
{
"name": "Condition 1",
"shortName": "A",
"evaluateToTrueOnNoData": false,
"evalDetail": {
"evalDetailType": "SINGLE_METRIC",
"metricAggregateFunction": "VALUE",
"metricPath": "Average CPU Used (ms)",
"metricEvalDetail": {
"metricEvalDetailType": "BASELINE_TYPE",
"baselineCondition": "WITHIN_BASELINE",
"baselineName": "All data - Last 15 days",
"compareValue": 30.5,
"baselineUnit": "PERCENTAGE"
}
},
"triggerEnabled": false,
"minimumTriggers": 0
}
],
"evalMatchingCriteria": {
"matchType": "ANY_NODE",
"value": null
}
},
"warningCriteria": {
"conditionAggregationType": "ALL",
"conditionExpression": null,
"conditions": [
{
"name": "Condition 1",
"shortName": "A",
"evaluateToTrueOnNoData": false,
"evalDetail": {
"evalDetailType": "METRIC_EXPRESSION",
"metricExpression": "({metric1} + ({metric2} * 3))",
"metricExpressionVariables": [
{
"variableName": "metric1",
"metricAggregateFunction": "VALUE",
"metricPath": "95th Percentile Response Time (ms)"
},
{
"variableName": "metric2",
"metricAggregateFunction": "MAXIMUM",
"metricPath": "Average CPU Used (ms)"
}
],
"metricEvalDetail": {
"metricEvalDetailType": "SPECIFIC_TYPE",
"compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
"compareValue": 10
}
},
"triggerEnabled": false,
"minimumTriggers": 0
}
],
"evalMatchingCriteria": {
"matchType": "ANY_NODE",
"value": null
}
}
}
}
正常性ルールの更新
この API は、既存の正常性ルール(必須フィールド)を、指定された正常性ルール ID の詳細で更新します。「プロパティの詳細」を参照してください。
リソースURL
PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/{health-rule-id}
要求/応答の形式
JSON
例
{
"name": "My new health rule",
"enabled": true,
"useDataFromLastNMinutes": 30,
"waitTimeAfterViolation": 5,
"affects": {
"affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
"affectedBusinessTransactions": {
"businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
}
},
"evalCriterias": {
"criticalCriteria": {
"conditionAggregationType": "ALL",
"conditions": [
{
"name": "Condition 1",
"shortName": "A",
"evaluateToTrueOnNoData": false,
"evalDetail": {
"evalDetailType": "SINGLE_METRIC",
"metricAggregateFunction": "VALUE",
"metricPath": "Average CPU Used (ms)",
"metricEvalDetail": {
"metricEvalDetailType": "BASELINE_TYPE",
"baselineCondition": "WITHIN_BASELINE",
"baselineName": "All Data - Last 15 Days",
"baselineUnit": "PERCENTAGE",
"compareValue": 30.5
}
}
}
]
},
"warningCriteria": {
"conditionAggregationType": "ALL",
"conditions": [
{
"name": "Condition 1",
"shortName": "A",
"evalDetail": {
"evalDetailType": "METRIC_EXPRESSION",
"metricExpression": "({metric1} + ({metric2} * 3))",
"metricExpressionVariables": [
{
"variableName": "metric1",
"metricAggregateFunction": "VALUE",
"metricPath": "95th Percentile Response Time (ms)"
},
{
"variableName": "metric2",
"metricAggregateFunction": "MAXIMUM",
"metricPath": "Average CPU Used (ms)"
}
],
"metricEvalDetail": {
"metricEvalDetailType": "SPECIFIC_TYPE",
"compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
"compareValue": 10
}
}
}
]
}
}
}
{
"name": "My new health rule",
"enabled": true,
"useDataFromLastNMinutes": 30,
"waitTimeAfterViolation": 5,
"affects": {
"affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
"affectedBusinessTransactions": {
"businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
}
},
"evalCriterias": {
"criticalCriteria": {
"conditionAggregationType": "ALL",
"conditions": [
{
"name": "Condition 1",
"shortName": "A",
"evaluateToTrueOnNoData": false,
"evalDetail": {
"evalDetailType": "SINGLE_METRIC",
"metricAggregateFunction": "VALUE",
"metricPath": "Average CPU Used (ms)",
"metricEvalDetail": {
"metricEvalDetailType": "BASELINE_TYPE",
"baselineCondition": "WITHIN_BASELINE",
"baselineName": "All Data - Last 15 Days",
"baselineUnit": "PERCENTAGE",
"compareValue": 30.5
}
}
}
]
},
"warningCriteria": {
"conditionAggregationType": "ALL",
"conditions": [
{
"name": "Condition 1",
"shortName": "A",
"evalDetail": {
"evalDetailType": "METRIC_EXPRESSION",
"metricExpression": "({metric1} + ({metric2} * 3))",
"metricExpressionVariables": [
{
"variableName": "metric1",
"metricAggregateFunction": "VALUE",
"metricPath": "95th Percentile Response Time (ms)"
},
{
"variableName": "metric2",
"metricAggregateFunction": "MAXIMUM",
"metricPath": "Average CPU Used (ms)"
}
],
"metricEvalDetail": {
"metricEvalDetailType": "SPECIFIC_TYPE",
"compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
"compareValue": 10
}
}
}
]
}
}
}
正常性ルールの削除
指定された ID を持つ既存の正常性ルールを削除します。
リソースURL
DELETE <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/{health-rule-id}
正常性ルール構成の更新
この API は、正常性ルールの 1 つ以上の構成設定を更新します。「プロパティの詳細」を参照してください。
要求の次のフィールドのいずれかまたは両方に入力できます。
- 正常性ルールを有効/無効にします。
- 正常性ルールのスケジュールを更新します。
リソースURL
PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/{health-rule-id}/configuration
要求/応答の形式
JSON
例
{
"enabled": "false",
"scheduleName": "Weeknights: 11pm-6am, Mon-Fri"
}
{
"id": 26,
"name": "My new health rule",
"enabled": false,
"useDataFromLastNMinutes": 30,
"waitTimeAfterViolation": 5,
"scheduleName": "Weeknights: 11pm-6am, Mon-Fri",
"affects": {
"affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
"affectedBusinessTransactions": {
"businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
}
},
"evalCriterias": {
"criticalCriteria": {
"conditionAggregationType": "ALL",
"conditionExpression": null,
"conditions": [
{
"name": "Condition 1",
"shortName": "A",
"evaluateToTrueOnNoData": false,
"evalDetail": {
"evalDetailType": "SINGLE_METRIC",
"metricAggregateFunction": "VALUE",
"metricPath": "Average CPU Used (ms)",
"metricEvalDetail": {
"metricEvalDetailType": "BASELINE_TYPE",
"baselineCondition": "WITHIN_BASELINE",
"baselineName": "All data - Last 15 days",
"compareValue": 30.5,
"baselineUnit": "PERCENTAGE"
}
},
"triggerEnabled": false,
"minimumTriggers": 0
}
],
"evalMatchingCriteria": {
"matchType": "ANY_NODE",
"value": null
}
},
"warningCriteria": {
"conditionAggregationType": "ALL",
"conditionExpression": null,
"conditions": [
{
"name": "Condition 1",
"shortName": "A",
"evaluateToTrueOnNoData": false,
"evalDetail": {
"evalDetailType": "METRIC_EXPRESSION",
"metricExpression": "({metric1} + ({metric2} * 3))",
"metricExpressionVariables": [
{
"variableName": "metric1",
"metricAggregateFunction": "VALUE",
"metricPath": "95th Percentile Response Time (ms)"
},
{
"variableName": "metric2",
"metricAggregateFunction": "MAXIMUM",
"metricPath": "Average CPU Used (ms)"
}
],
"metricEvalDetail": {
"metricEvalDetailType": "SPECIFIC_TYPE",
"compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
"compareValue": 10
}
},
"triggerEnabled": false,
"minimumTriggers": 0
}
],
"evalMatchingCriteria": {
"matchType": "ANY_NODE",
"value": null
}
}
}
}
応答コード
コード | 説明 |
---|---|
200 | 正常に取得されました |
201 | 正常に作成されました |
204 | 正常に削除されました |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
404 | リソースが見つかりません |
409 | すでに存在します |
Property Details
HealthRule
Property Name | Type and Valid Values | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | 整数 | システムによって自動生成され、応答で返されます。 これは | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string 最小長:1 | 正常性ルールの名前。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enabled | boolean デフォルト値: | 正常性ルールを有効/無効の状態に設定します。正常性ルールは、 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 整数 最小値:1 最大値:360 | 収集されたデータが正常性ルールの評価の対象となる時間間隔(分単位)。1 ~ 9 の範囲の値または 10 の倍数(360 未満)を入力します。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
waitTimeAfterViolation | 整数 最小時間:1 分 | 違反後の待機時間(分単位)。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
scheduleName | string デフォルトオプション: | 評価のために正常性ルールに関連付けられるスケジュールの名前。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
affects* | 正常性ルールの影響を受けるエンティティについて説明します。たとえば、ビジネストランザクション、サーバ、データベースなどです。 影響
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
evalCriterias* | 正常性ルールを評価するためのブール式として表現された条件または一連の条件(最大 8 個)を定義します。 重大条件は警告条件より前に評価されます。重大条件と警告条件が同じ正常性ルールで定義されていると、警告条件は重大条件が
重大条件と警告条件が同じ正常性ルールで定義されていると、警告条件は重大条件が
|
HealthRuleSummaryArray
プロパティ | タイプ |
---|---|
id* | 整数 |
name | 文字列 minLength: 1 |
enabled* | boolean |
HealthRuleConfiguration
正常性ルールの JSON ペイロード全体を送信する必要なく、個別に更新できる正常性ルールの構成詳細。1 つ以上のプロパティを指定することができ、それらのプロパティはすべて新しい指定値に設定されます。
プロパティ | タイプ |
---|---|
enabled | boolean |
scheduleName | string |
MetricEvalDetail
プロパティ | タイプ | Enums |
---|---|---|
metricEvalDetailType* | string |
|
BaselineMetricEvalDetail
正常性ルールを評価するために使用されるベースラインからのメトリックの偏差。
プロパティ | タイプ | Enums |
---|---|---|
metricEvalDetailType* | string |
|
baselineCondition* | string |
|
baselineName* | string minLength: 1 | |
compareValue* | 数字 最小値:0 | |
baselineUnit* | string |
|
SpecificValueMetricEvalDetail
正常性ルールを評価するために使用される特定値からのメトリックの偏差。
プロパティ | タイプ | Enums |
---|---|---|
metricEvalDetailType* | string |
|
compareCondition* | string |
|
compareValue* | 数字 最小値:0 |
MetricAggregateFunction
偏差を判別して正常性ルールを評価するために集約されたメトリック。
プロパティ | タイプ | Enums |
---|---|---|
| string |
|
SingleMetricEvalDetail
正常性ルールを評価するために使用される「集約値」からの単一メトリックの偏差。
プロパティ | タイプ | Enums |
---|---|---|
| string |
|
metricAggregateFunction* | string |
|
metricPath* | string minLength: 1 マシンエージェント階層を含む正常性ルールのメトリックパスが適切に解決されるようにするには、カスタムメトリックの縦棒の前にエスケープ文字「\\」を追加します。低下要因になっています。 Application Infrastructure Performance|Root\\|Containers\\|Fulfillment-Service|Individual Nodes|9b711cda4a83|Hardware Resources|CPU|%Busy | |
metricEvalDetail* | string |
|
MetricExpressionEvalDetail
正常性ルールを評価するために使用されるメトリック式。
プロパティ | タイプ | Enums | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string |
| ||||||||||||
metricExpression* | string minLength: 1 | |||||||||||||
metricExpressionVariables* | string minItems:2 | MetricDetailWithVariableName
| ||||||||||||
metricEvalDetail* | string | SpecificValueMetricEvalDetail
|
MetricDetailWithVariableName
プロパティ | タイプ | Enums |
---|---|---|
variableName* | string minLength: 1 | |
metricAggregateFunction* | string |
|
metricPath* | string minLength: 1 |
NodeEvalMatchingCriteria
Property | タイプ | Enums |
---|---|---|
matchType | string |
|
| 数字 最小値:0 |
Condition
true
または false
に個別に評価できる単一の条件。条件のリスト(最大 8 つ)と、基準を形成するための他のプロパティ。
プロパティ | 説明 | タイプ/列挙体 | ||||||
---|---|---|---|---|---|---|---|---|
name* | 条件の名前。 | string | ||||||
shortname* | CUSTOM conditionType の評価に conditionExpression で使用される短縮名。 | string パターン:^[A-Z]{1,3}$ Enums
| ||||||
evaluateToTrueOnNoData | 条件がベースになっている任意のメトリックがデータを返さない場合の条件の評価を制御します。データが返されない場合、条件はデフォルトで unknown と評価されます。正常性ルールが true に評価されるすべての条件に基づいている場合、データが返されないと、正常性ルールがアクションをトリガーするかどうかに影響を与える可能性があります。 | boolean デフォルト: | ||||||
| 条件の評価対象として考慮されるメトリックの詳細。 | ConditionEvalDetail
| ||||||
triggerEnabled | true に設定すると、フィールド minimumTriggers の値が評価対象と見なされます。 | boolean デフォルト: | ||||||
minimumTriggers | ゼロ以外の値を設定すると、条件を評価するときに永続的しきい値が考慮されます。useDataFromLastNMinutes より小さい値を定義していることを確認します。 | integer デフォルト:0 最小値:0 最大値:30 |
ConditionEvalDetail
プロパティ | タイプ | Enums |
---|---|---|
evalDetailType | string |
|
基準
Property | Description | Type/Enums | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
conditionAggregationType | 正常性ルール違反を構成する条件評価基準。 | string デフォルト:ALL Enums
| |||||||||||||||||||||||||||
|
| 文字列 minLength: 1 | |||||||||||||||||||||||||||
|
条件のリスト(最大 8 つ)と、基準を形成するための他のプロパティ。 | 文字列 minItems:1 条件
| |||||||||||||||||||||||||||
evalMatchingCriteria | 次の正常性ルールタイプの条件を評価する基準。
正常性ルールに違反したと見なされるために必要な、影響を受けたエンティティで条件に違反しているノードの数を定義します。 | NodeEvalMatchingCriteria
|
EntityMatchingPattern
プロパティ | タイプ | Enums |
---|---|---|
matchTo* | string |
|
matchValue* | string minLength: 1 | |
shouldNot | boolean |
AffectedTiers
プロパティ | タイプ | Enums |
---|---|---|
affectedTierScope* | string |
|
AllTiers
影響を受ける階層の範囲は、影響を受けるエンティティのすべての階層に設定されます。
プロパティ | タイプ | Enums |
---|---|---|
affectedTierScope* | string |
|
SpecificTiers
影響を受ける階層の範囲は、影響を受けるエンティティの特定の階層に設定されます。
プロパティ | タイプ | Enums |
---|---|---|
affectedTierScope* | string |
|
tiers* | string minItems: 1 |
AffectedNodes
プロパティ | タイプ | Enums |
---|---|---|
affectedNodeScope* | string |
|
AllNodes
影響を受けるノードの範囲は、影響を受けるエンティティのすべてのノードに設定されます。
Property | Type | Enums |
---|---|---|
affectedNodeScope* | string |
|
SpecificNodes
影響を受けるノードの範囲は、影響を受けるエンティティのすべてのノードに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
affectedNodeScope* | string | SPECIFIC_NODES |
nodes* | string minItems: 1 |
NodesOfSpecificTiers
影響を受けるノードの範囲は、影響を受けるエンティティの特定の階層のノードに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
affectedNodeScope* | string |
|
specificTiers* | string minItems: 1 |
NodesMatchingPattern
影響を受けるノードの範囲は、影響を受けるエンティティのパターンに一致するノードに設定されます。
プロパティ | タイプ | Enums | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
affectedNodeScope* | string |
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
NodePropertyVariableMatcher
影響を受けるノードの範囲は、影響を受けるエンティティの変数のプロパティと一致するノードに設定されます。
プロパティ | タイプ | Enums | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
affectedNodeScope* | string | NODE_PROPERTY_VARIABLE_MATCHER | ||||||||||||
propVarPairs* | アレイ minItems:1 |
|
OverallApplicationPerformance
影響を受けるエンティティの範囲は、全体的なアプリケーション パフォーマンスに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
affectedEntityType* | string |
|
BusinessTransactionPerformance
影響を受けるエンティティの範囲は、ビジネス トランザクション パフォーマンスに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
affectedEntityType* | string |
| ||||||
affectedBusinessTransactions* | string | AffectedBusinessTransactions
|
AffectedBusinessTransactions
プロパティ | タイプ | Enums |
---|---|---|
businessTransactionScope* | string |
|
AllBusinessTransactions
ビジネストランザクションの範囲が、すべてのビジネストランザクションに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
businessTransactionScope* | string |
|
SpecificBusinessTransactions
ビジネストランザクションの範囲は、特定のビジネストランザクションに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
businessTransactionScope* | string |
|
businessTransactions* | string minItems: 1 |
BusinessTransactionsInSpecificTiers
ビジネストランザクションの範囲は、特定の階層のビジネストランザクションに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
businessTransactionScope* | string |
|
specificTiers* | string minItems: 1 |
BusinessTransactionsMatchingPattern
ビジネストランザクションの範囲は、特定のパターンに一致するビジネストランザクションに設定されます。
プロパティ | タイプ | Enums | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
businessTransactionScope* | string |
| ||||||||||||
specificTiers* | string | EntityMatchingPattern
|
TierNodeTransactionPerformance
影響を受けるエンティティのタイプは、階層およびノードトランザクションのパフォーマンスに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
affectedEntityType* | string |
| ||||||
affectedEntities* | string | AffectedTierOrNodeEntities
|
AffectedTierOrNodeEntities
プロパティ | タイプ | Enums |
---|---|---|
tierOrNode* | string |
|
TierAffectedEntities
影響を受けるエンティティの範囲は、階層に設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
tierOrNode* | string |
| ||||||
affectedTiers* | string | AffectedTiers
|
NodeAffectedEntities
影響を受けるエンティティの範囲は、ノードに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
tierOrNode* | string |
| ||||||
typeofNode* | string |
| ||||||
affectedNodes* | string | AffectedNodes
|
TierNodeHardware
影響を受けるエンティティタイプは、階層ノードハードウェアに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
affectedEntityType* | string |
| ||||||
affectedEntities* | string | AffectedTierOrNodeEntities
|
ServersInApplication
影響を受けるエンティティタイプは、servers in the applicationに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
affectedEntityType* | string |
| ||||||
affectedServers* | string | ApplicationAffectedServers
|
ApplicationAffectedServers
プロパティ | タイプ | Enums |
---|---|---|
serversScope* | string |
|
AllServersInApplication
サーバの範囲は、アプリケーション内のすべてのサーバに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
serversScope* | string |
|
SpecificServersInApplication
サーバの範囲は、アプリケーション内の特定のサーバに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
serversScope* | string |
|
specificServers* | string minLength: 1 |
AllServersInSpecificTiers
サーバの範囲は、特定の階層内のすべてのサーバに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
serversScope* | string |
|
specificTiers* | string minItems: 1 |
Backends
影響を受けるエンティティタイプは、バックエンドに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
affectedEntityType* | string |
| ||||||
affectedBackends* | string | AffectedBackends
|
AffectedBackends
プロパティ | タイプ | Enums |
---|---|---|
backendScope* | string |
|
AllBackends
バックエンドの範囲は、すべてのバックエンドに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
backendScope* | string |
|
SpecificBackends
バックエンドの範囲は、特定のバックエンドに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
backendScope* | string |
|
backends* | string minItems: 1 |
BackendsMatchingPattern
バックエンドの範囲は、特定のパターンに一致するバックエンドに設定されます。
プロパティ | タイプ | Enums | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
backendScope* | string |
| ||||||||||||
patternMatcher* | string | EntityMatchingPattern
|
Errors
影響を受けるエンティティタイプは、エラーに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
affectedEntityType* | string |
| ||||||
affectedErrors* | string | AffectedErrors
|
AffectedErrors
プロパティ | タイプ | Enums |
---|---|---|
errorScope* | string |
|
AllErrors
エラーの範囲は、すべてのエラーに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
errorScope* | string |
|
SpecificErrors
エラーの範囲は、特定のエラーに設定されます。
プロパティ | タイプ | 説明/列挙型 |
---|---|---|
errorScope* | string |
|
errors*。 | string minItems: 1 | |
階層 | string minItems: 1 | エラー名が複数の階層に属する場合に使用します。エラー名と同じ順序で階層名を
|
JSON
|
ErrorsOfSpecificTiers
エラーの範囲は、特定の階層に関連するエラーに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
errorScope* | string |
|
specificTiers* | string minItems: 1 |
ErrorsMatchingPattern
エラーの範囲は、特定のパターンに一致するエラーに設定されます。
プロパティ | タイプ | Enums | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorScope* | string |
| ||||||||||||
patternMatcher | string | EntityMatchingPattern
|
ServiceEndpoints
影響を受けるエンティティタイプは、サービスエンドポイントに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
affectedEntityType* | string |
| ||||||
affectedServiceEndpoints* | AffectedServiceEndpoints
|
AffectedServiceEndpoints
プロパティ | タイプ | Enums |
---|---|---|
serviceEndpointScope* | string |
|
AllServiceEndpoints
サービスエンドポイントの範囲は、すべてのサービスエンドポイントに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
serviceEndpointScope* | string |
|
SpecificServiceEndpoints
サービスエンドポイントの範囲は、特定のサービスエンドポイントに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
serviceEndpointScope* | string |
|
serviceEndpoints* | string minItems: 1 |
ServiceEndpointsInSpecificTiers
サービスエンドポイントの範囲は、特定のサービスエンドポイントに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
serviceEndpointScope* | string |
|
specificTiers* | string minItems: 1 |
ServiceEndpointsMatchingPattern
サービスエンドポイントの範囲は、特定のパターンに一致するサービスエンドポイントに設定されます。
プロパティ | タイプ | Enums | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
serviceEndpointScope* | string |
| ||||||||||||
patternMatcher* | string minItems: 1 | EntityMatchingPattern
|
InformationPoints
影響を受けるエンティティタイプは、情報ポイントに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
affectedEntityType* | string |
| ||||||
affectedInformationPoints* | string | AffectedInformationPoints
|
AffectedInformationPoints
プロパティ | タイプ | Enums |
---|---|---|
informationPointScope* | string |
|
AllInformationPoints
情報ポイントの範囲は、すべての情報ポイントに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
informationPointScope* | string |
|
SpecificInformationPoints
情報ポイントの範囲は、特定の情報ポイントに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
informationPointScope* | string |
|
informationPoints* | string minItems: 1 |
InformationPointsMatchingPattern
情報ポイントの範囲は、パターンに一致する情報ポイントに設定されます。
プロパティ | タイプ | Enums | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
informationPointScope* | string |
| ||||||||||||
patternMatcher* | string minItems: 1 | EntityMatchingPattern
|
Custom
影響を受けるエンティティタイプは、カスタムに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
affectedEntityType* | string |
| ||||||
affectedEntityScope* | string | AffectedEntityScope
|
AffectedEntityScope
プロパティ | タイプ | Enums |
---|---|---|
entityScope* | string |
|
ApplicationPerformance
影響を受けるエンティティの範囲は、アプリケーション パフォーマンスに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
entityScope* | string |
|
SpecificEntityPerformance
影響を受けるエンティティの範囲は、特定のエンティティパフォーマンスに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
entityScope* | string |
|
entityType* | string |
|
affectedEntityName* | string minLength: 1 |
Databases
影響を受けるエンティティタイプは、データベースに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
affectedEntityType* | string |
| ||||||
databaseType* | string |
| ||||||
affectedDatabases* | string | AffectedDatabases
|
AffectedDatabases
プロパティ | タイプ | Enums |
---|---|---|
databaseScope* | string |
|
AllDatabases
影響を受けるデータベースの範囲は、すべてのデータベースに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
databaseScope* | string |
|
SpecificDatabases
影響を受けるデータベースの範囲は、特定のデータベースに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
databaseScope* | string |
| ||||||
databases* | string minItems: 1 | DbServer
|
DbServer
プロパティ | タイプ |
---|---|
serverName* | string minLength: 1 |
collectorConfigName* | string minLength: 1 |
Servers
影響を受けるエンティティタイプは、サーバに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
affectedEntityType* | string |
| ||||||
serverSelectionCriteria* | string | AffectedServersCriteria
|
AffectedServersCriteria
プロパティ | タイプ | Enums |
---|---|---|
selectServersBy* | string |
|
AffectedServers
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
selectServersBy* | string |
| ||||||
affectedServers* | string | ServerSelectionCriteria
|
ServerSelectionCriteria
プロパティ | タイプ | Enums |
---|---|---|
severSelectionScope* | string |
|
AllServersInAccount
サーバの範囲は、アカウント内のすべてのサーバに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
severSelectionScope* | string |
|
ServersWithinSubGroup
サーバの範囲は、サブグループ内のすべてのサーバに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
severSelectionScope* | string |
|
subGroups* | string minItems: 1 |
SpecificServers
サーバの範囲は、特定のサーバに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
severSelectionScope* | string |
|
servers* | string minItems: 1 |
ServersMatchingPattern
サーバの範囲は、特定のパターンに一致するサーバに設定されます。
プロパティ | タイプ | Enums | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
severSelectionScope* | string |
| ||||||||||||
patternMatcher* | EntityMatchingPattern
|
AffectedServerSubGroups
影響を受けるサーバの範囲は、サブグループ内の影響を受けるサーバに設定されます。
プロパティ | タイプ | Enums | ||||||
---|---|---|---|---|---|---|---|---|
selectServersBy* | string |
| ||||||
subGroups* | string minItems: 1 | AffectedSubGroups
|
AffectedSubGroups
プロパティ | タイプ | Enums |
---|---|---|
subGroupScope* | string |
|
AllSubGroups
影響を受けるサーバの範囲は、すべてのサブグループ内のサーバに設定されます。
Property | Type | Enums |
---|---|---|
subGroupScope* | string |
|
SpecificServerSubGroups
影響を受けるサーバの範囲は、servers within specific subgroupsに設定されます。
プロパティ | タイプ | Enums |
---|---|---|
subGroupScope* | string |
|
subGroupNames | string minItems: 1 |
Affects
正常性ルールが影響するエンティティについて説明します。たとえば、ビジネストランザクション、サーバ、データベースなどです。
プロパティ | タイプ | Enums |
---|---|---|
| string |
|
EvalCriterias
プロパティ | Type/Enums | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
criticalCriteria | 基準重大条件は警告条件より前に評価されます。重大条件と警告条件が同じ正常性ルールで定義されていると、警告条件は重大条件が
| |||||||||||||||||||||||||||||||||||||||||||||||||||
warningCriteria | 基準重大条件と警告条件が同じ正常性ルールで定義されていると、警告条件は重大条件が
|
HealthRuleSummary
プロパティ | タイプ |
---|---|
id* | 整数 |
name | 文字列 |
enabled* | boolean |
ErrorResponse
プロパティ | タイプ |
---|---|
statusCode | 整数 |
message | 文字列 |
*This property is required (mandatory).
例のダウンロード
正常性ルール health_rule_request_examples.zip
を設定するのに役立つ一連の例をダウンロードします。
Swagger YAML 仕様のダウンロード
Swagger YAML 仕様 health_rule_openapi.yml
をダウンロードします。