アクティブなアラートルールの詳細を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cms:DescribeActiveMetricRuleList |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Product |
string |
必須 |
アクティブなアラートルールをサポートするクラウドサービスの略称。 クラウドサービス名の取得方法の詳細については、「DescribeProductsOfActiveMetricRule」をご参照ください。 |
ecs |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
なし。 |
||
| Code |
string |
HTTP ステータスコード。 説明
状態コード 200 は、リクエストが成功したことを示します。 |
200 |
| Message |
string |
返されたメッセージ。 |
The Request is not authorization. |
| RequestId |
string |
リクエスト ID。 |
F82E6667-7811-4BA0-842F-5B2DC42BBAAD |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値:
|
true |
| Datapoints |
object |
||
| Alarm |
array<object> |
アラートルールの詳細。 |
|
|
object |
|||
| SilenceTime |
string |
トリガー条件が満たされても新しいアラートが送信されないミュート期間。 単位:秒。 |
86400 |
| MetricName |
string |
メトリック名。 |
cpu_total |
| EvaluationCount |
string |
アラートがトリガーされる前に、メトリック値がアラート条件を満たす連続回数。 |
3 |
| Webhook |
string |
コールバック URL。 |
https://www.aliyun.com |
| State |
string |
アラートルールが有効かどうかを示します。 |
Enable |
| ContactGroups |
string |
アラートグループ。 |
ECS_Group |
| Namespace |
string |
クラウドサービスの名前空間。 |
acs_ecs_dashboard |
| RuleName |
string |
アラートルールの名前。 |
SystemDefault_acs_rds_dashboard_CpuUsage |
| RuleId |
string |
アラートルールの ID。 |
a151cd6023eacee2f0978e03863cc1697c89508**** |
| Period |
string |
モニタリングデータの集計期間。 単位:秒。 |
60 |
| ComparisonOperator |
string |
アラートルールで使用される比較演算子。有効な値:
|
> |
| EndTime |
string |
アラートルールが有効な期間の終了時刻。 単位:時間。たとえば、値 23 は |
24 |
| StartTime |
string |
アラートルールが有効な期間の開始時刻。 単位:時間。たとえば、値 00 は |
00 |
| Threshold |
string |
アラートのしきい値。 |
90 |
| Statistics |
string |
統計メソッド。 |
Average |
| Enable |
string |
アラートルールが有効かどうかを示します。有効な値:
|
true |
| AlertList |
object |
||
| Alert |
array<object> |
アラートルールの詳細。結果は、DescribeMetricRuleList 操作によって返されるものと同じ構造です。 |
|
|
array<object> |
|||
| SilenceTime |
string |
トリガー条件が満たされても新しいアラートが送信されないミュート期間。 単位:秒。 |
86400 |
| MetricName |
string |
メトリックの名前。 |
cpu_total |
| Webhook |
string |
コールバック URL。 |
http://www.aliyun.com |
| ContactGroups |
string |
アラートグループ。 |
ECS_Group |
| Namespace |
string |
Alibaba Cloud サービスの名前空間。 |
acs_ecs_dashboard |
| EffectiveInterval |
string |
アラートルールが有効な期間。 |
00:00-23:59 |
| NoEffectiveInterval |
string |
アラートルールが無効な期間。 |
00:00-06:00 |
| MailSubject |
string |
アラート通知メールの件名。 |
ECS_Bucket |
| RuleName |
string |
アラートルールの名前。 |
myAlert |
| RuleId |
string |
アラートルールの ID。 |
ruleIdxxxx |
| Period |
string |
モニタリングデータの集計期間。 単位:秒。 |
60 |
| AlertState |
string |
アラートルールの状態。有効な値:
|
OK |
| Dimensions |
string |
指定されたリソースのモニタリングデータ。 |
"" |
| EnableState |
boolean |
アラートルールが有効かどうかを示します。有効な値:
|
true |
| Resources |
string |
アラートルールに関連付けられているリソース。 |
[{"resource":"_ALL"}] |
| Escalations |
object |
異なるレベルのアラートをトリガーするための条件。 |
|
| Info |
object |
情報 (Info) レベルのアラートをトリガーするための条件。 |
|
| ComparisonOperator |
string |
メトリック値を情報 (Info) レベルのアラートのしきい値と比較するために使用されるオペレーター。有効な値:
|
GreaterThanThreshold |
| Times |
string |
情報 (Info) レベルのアラートがトリガーされる前に、メトリック値がアラート条件を満たす連続回数。 |
3 |
| Threshold |
string |
情報 (Info) レベルのアラートのしきい値。 |
95 |
| Statistics |
string |
情報 (Info) レベルのアラートの統計メソッド。 |
Average |
| Warn |
object |
警告 (Warn) レベルのアラートをトリガーするための条件。 |
|
| ComparisonOperator |
string |
メトリック値を警告 (Warn) レベルのアラートのしきい値と比較するために使用されるオペレーター。有効な値:
|
GreaterThanThreshold |
| Times |
string |
警告 (Warn) レベルのアラートがトリガーされる前に、メトリック値がアラート条件を満たす連続回数。 |
3 |
| Threshold |
string |
警告 (Warn) レベルのアラートのしきい値。 |
80 |
| Statistics |
string |
警告 (Warn) レベルのアラートの統計メソッド。 |
Average |
| Critical |
object |
重大 (Critical) レベルのアラートのトリガー条件。 |
|
| ComparisonOperator |
string |
メトリック値を重大 (Critical) レベルのアラートのしきい値と比較するために使用されるオペレーター。有効な値:
|
GreaterThanThreshold |
| Times |
string |
重大 (Critical) レベルのアラートがトリガーされる前に、メトリック値がアラート条件を満たす連続回数。 |
3 |
| Threshold |
string |
重大 (Critical) レベルのアラートのしきい値。 |
99 |
| Statistics |
string |
重大 (Critical) レベルのアラートの統計メソッド。 |
Average |
例
成功レスポンス
JSONJSON
{
"Code": "200",
"Message": "The Request is not authorization.",
"RequestId": "F82E6667-7811-4BA0-842F-5B2DC42BBAAD",
"Success": true,
"Datapoints": {
"Alarm": [
{
"SilenceTime": "86400",
"MetricName": "cpu_total",
"EvaluationCount": "3",
"Webhook": "https://www.aliyun.com",
"State": "Enable",
"ContactGroups": "ECS_Group",
"Namespace": "acs_ecs_dashboard",
"RuleName": "SystemDefault_acs_rds_dashboard_CpuUsage",
"RuleId": "a151cd6023eacee2f0978e03863cc1697c89508****",
"Period": "60",
"ComparisonOperator": ">",
"EndTime": "24",
"StartTime": "00",
"Threshold": "90",
"Statistics": "Average",
"Enable": "true"
}
]
},
"AlertList": {
"Alert": [
{
"SilenceTime": "86400",
"MetricName": "cpu_total",
"Webhook": "http://www.aliyun.com",
"ContactGroups": "ECS_Group",
"Namespace": "acs_ecs_dashboard",
"EffectiveInterval": "00:00-23:59",
"NoEffectiveInterval": "00:00-06:00",
"MailSubject": "ECS_Bucket",
"RuleName": "myAlert",
"RuleId": "ruleIdxxxx",
"Period": "60",
"AlertState": "OK",
"Dimensions": "\"\"",
"EnableState": true,
"Resources": "[{\"resource\":\"_ALL\"}]",
"Escalations": {
"Info": {
"ComparisonOperator": "GreaterThanThreshold",
"Times": "3",
"Threshold": "95",
"Statistics": "Average"
},
"Warn": {
"ComparisonOperator": "GreaterThanThreshold",
"Times": "3",
"Threshold": "80",
"Statistics": "Average"
},
"Critical": {
"ComparisonOperator": "GreaterThanThreshold",
"Times": "3",
"Threshold": "99",
"Statistics": "Average"
}
}
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | ParameterInvalid | %s | |
| 401 | AccessDeniedException | You donot have sufficient access to perform this action. | |
| 402 | LimitExceeded | The quota for this customer had been reached. | |
| 403 | AccessForbidden | The X.509 certificate or cms access key ID provided does not exist in our records. | |
| 404 | ResourceNotFound | The specified resource is not found. | The specified resource is not found. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。