DescribeMetricRuleList API によるアラートルール一覧の取得 - CMS - Alibaba Cloud - Cloud Monitor

アラートルールリスト内のすべてのルールを照会します。

操作説明

この Topic では、現在の Alibaba Cloud アカウントのアラートルールリスト内のすべてのアラートルールをクエリする例を示します。応答は、アラートルールリストにアラートルールが 1 つだけ含まれていることを示しています。アラートルールの名前は Rule_01 で、ID は applyTemplate344cfd42-0f32-4fd6-805a-88d7908a**** です。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:DescribeMetricRuleList

get

*全部资源

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
MetricName	string	任意	メトリック名。メトリック名の取得方法については、 DescribeMetricMetaList またはクラウドサービスメトリックを参照してください。注意: 複合メトリックの場合、最初のメトリックでのみ検索できます。	cpu_total
EnableState	boolean	任意	アラートルールの有効状態。有効な値: true: 有効。 false: 無効。	true
Namespace	string	任意	クラウドサービスの名前空間。クラウドサービスの名前空間の取得方法については、 DescribeMetricMetaList またはクラウドサービスメトリックを参照してください。	acs_ecs_dashboard
Page	integer	任意	ページ番号。最小値: 1。デフォルト値: 1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。最小値: 1。デフォルト値: 10。	10
AlertState	string	任意	アラートルールのステータス。有効な値: OK: 法線。 ALARM: アラート。 INSUFFICIENT_DATA: データなし。	OK
Dimensions	string	任意	指定されたリソースのモニタリングディメンション。フォーマット: `key:value` ペアのコレクション。例: `{"userId":"120886317861**"}` および `{"instanceId":"i-2ze2d6j5uhg20x47**"}`。	{"instanceId":"i-2ze2d6j5uhg20x47****"}
RuleName	string	任意	アラートルールの名前。このパラメーターはあいまい検索をサポートします。	Rule_01
GroupId	string	任意	アプリケーショングループの ID。アプリケーショングループ ID の取得方法については、 DescribeMonitorGroups を参照してください。	7301****
RuleIds	string	任意	アラートルールの ID。複数の ID はコンマ (,) で区切ります。一度に最大 20 個のアラートルールをクエリできます。	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****

共通リクエストパラメーターの詳細については、共通パラメーターを参照してください。

レスポンスフィールド

フィールド	型	説明	例
	object	なし。
Code	integer	HTTP 状態コード。説明 200 は成功を示します。	200
Message	string	エラーメッセージ。	The specified resource is not found.
RequestId	string	リクエスト ID。	386C6712-335F-5054-930A-CC92B851ECBA
Total	string	レコードの総数。	1
Success	boolean	操作が成功したかどうかを示します。有効な値: true: 成功。 false: 失敗。	true
Alarms	object
Alarm	array<object>	アラートルールのリスト。
	array<object>	なし。
SilenceTime	integer	ミュート期間。単位: 秒。デフォルト値: 86400。最小値: 3600。モニタリングデータがアラートルールのしきい値を継続的に超過した場合、各ミュート期間内にアラート通知は 1 回のみ送信されます。	86400
MetricName	string	メトリック名。	cpu_total
Webhook	string	アラート通知が送信されるコールバック URL。CloudMonitor は POST リクエストを使用してこの URL にアラート情報をプッシュします。HTTP のみがサポートされています。	https://www.aliyun.com
ContactGroups	string	アラート連絡先グループ。	ECS_Alarm
SourceType	string	アラートルールのタイプ。有効な値: METRIC (時系列メトリックアラートルールを示します)。	METRIC
Namespace	string	Alibaba Cloud サービスの名前空間。	acs_ecs_dashboard
MailSubject	string	アラートメールの主題。	"${serviceType}-${metricName}-${levelDescription} notification(${dimensions})"
NoEffectiveInterval	string	アラートルールが無効になる時間範囲。	00:00-05:30
EffectiveInterval	string	アラートルールの有効期間。	05:31-23:59
RuleName	string	アラートルールの名前。	Rule_01
AlertState	string	アラートルールの状態。有効な値: OK: 法線。 ALARM: アラート。 INSUFFICIENT_DATA: データなし。	OK
Period	string	統計期間。	60
RuleId	string	アラートルールの ID。	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****
GroupName	string	アプリケーショングループの名前。説明このパラメーターは、アラートルールがアプリケーショングループに関連付けられている場合にのみ返されます。	ECS_Group
GroupId	string	アプリケーショングループの ID。	7301****
Dimensions	string	アラートルールのディメンション。	[{"instanceId":"i-2ze2d6j5uhg20x47****"}]
EnableState	boolean	有効状態。有効な値: true: 有効。 false: 無効。	true
Resources	string	アラートルールに関連付けられたリソース。	[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]
Escalations	object	異なるアラートレベルのトリガー条件。
Info	object	Info レベルアラートのトリガー条件。
ComparisonOperator	string	Info レベルのしきい値の比較演算子。有効な値: GreaterThanOrEqualToThreshold: しきい値以上。 GreaterThanThreshold: しきい値より大きい。 LessThanOrEqualToThreshold: しきい値以下。 LessThanThreshold: しきい値より小さい。 NotEqualToThreshold: しきい値と等しくない。 GreaterThanYesterday: 前日の同時間の値より大きい。 LessThanYesterday: 前日の同時間の値より小さい。 GreaterThanLastWeek: 前週の同時間の値より大きい。 LessThanLastWeek: 前週の同時間の値より小さい。 GreaterThanLastPeriod: 前の期間の値より大きい。 LessThanLastPeriod: 前の期間の値より小さい。	GreaterThanOrEqualToThreshold
PreCondition	string	Info レベルアラートの前提条件。このパラメーターは、ComparisonOperator が前年比または前期比の比較にセットされている場合に ComparisonOperator パラメーターと連携して機能します。たとえば、このパラメーターが $Average>80 にセットされ、ComparisonOperator が GreaterThanYesterday にセットされ、Threshold が 10 にセットされている場合、平均値が 80 を超え、前日と比較して 10% 以上増加した期間にアラートがトリガーされます。説明 $Average>0 の $Average は、$モニタリング結果フィールド値のフォーマットのプレースホルダーです。CloudMonitor はこれを対応する統計値または生のモニタリング値に置き換えます。	$Average>80
Times	integer	Info レベルアラートの連続発生回数。しきい値がこの連続回数を超えた場合にのみアラートがトリガーされます。	3
Threshold	string	Info レベルアラートのしきい値。	90
Statistics	string	Info レベルアラートの統計メソッド。	Average
Warn	object	Warn レベルアラートのトリガー条件。
ComparisonOperator	string	Warn レベルのしきい値の比較演算子。有効な値: GreaterThanOrEqualToThreshold: しきい値以上。 GreaterThanThreshold: しきい値より大きい。 LessThanOrEqualToThreshold: しきい値以下。 LessThanThreshold: しきい値より小さい。 NotEqualToThreshold: しきい値と等しくない。 GreaterThanYesterday: 前日の同時間の値より大きい。 LessThanYesterday: 前日の同時間の値より小さい。 GreaterThanLastWeek: 前週の同時間の値より大きい。 LessThanLastWeek: 前週の同時間の値より小さい。 GreaterThanLastPeriod: 前の期間の値より大きい。 LessThanLastPeriod: 前の期間の値より小さい。	GreaterThanOrEqualToThreshold
PreCondition	string	Warn レベルアラートの前提条件。このパラメーターは、ComparisonOperator が前年比または前期比の比較にセットされている場合に ComparisonOperator パラメーターと連携して機能します。たとえば、このパラメーターが $Average>80 にセットされ、ComparisonOperator が GreaterThanYesterday にセットされ、Threshold が 10 にセットされている場合、平均値が 80 を超え、前日と比較して 10% 以上増加した期間にアラートがトリガーされます。説明 $Average>0 の $Average は、$モニタリング結果フィールド値のフォーマットのプレースホルダーです。CloudMonitor はこれを対応する統計値または生のモニタリング値に置き換えます。	$Average>80
Times	integer	Warn レベルアラートの連続発生回数。しきい値がこの連続回数を超えた場合にのみアラートがトリガーされます。	3
Threshold	string	Warn レベルアラートのしきい値。	90
Statistics	string	Warn レベルアラートの統計メソッド。	Average
Critical	object	Critical レベルアラートのトリガー条件。
ComparisonOperator	string	Critical レベルのしきい値の比較演算子。有効な値: GreaterThanOrEqualToThreshold: しきい値以上。 GreaterThanThreshold: しきい値より大きい。 LessThanOrEqualToThreshold: しきい値以下。 LessThanThreshold: しきい値より小さい。 NotEqualToThreshold: しきい値と等しくない。 GreaterThanYesterday: 前日の同時間の値より大きい。 LessThanYesterday: 前日の同時間の値より小さい。 GreaterThanLastWeek: 前週の同時間の値より大きい。 LessThanLastWeek: 前週の同時間の値より小さい。 GreaterThanLastPeriod: 前の期間の値より大きい。 LessThanLastPeriod: 前の期間の値より小さい。	GreaterThanOrEqualToThreshold
PreCondition	string	Critical レベルアラートの前提条件。このパラメーターは、ComparisonOperator が前年比または前期比の比較にセットされている場合に ComparisonOperator パラメーターと連携して機能します。たとえば、このパラメーターが $Average>80 にセットされ、ComparisonOperator が GreaterThanYesterday にセットされ、Threshold が 10 にセットされている場合、平均値が 80 を超え、前日と比較して 10% 以上増加した期間にアラートがトリガーされます。説明 $Average>0 の $Average は、`$モニタリング結果フィールド値` のフォーマットのプレースホルダーです。CloudMonitor はこれを対応する統計値または生のモニタリング値に置き換えます。	$Average>80
Times	integer	Critical レベルアラートの連続発生回数。しきい値がこの連続回数を超えた場合にのみアラートがトリガーされます。	3
Threshold	string	Critical レベルアラートのしきい値。	90
Statistics	string	Critical レベルアラートの統計メソッド。	Average
NoDataPolicy	string	モニタリングデータが見つからない場合の処理メソッド。有効な値: KEEP_LAST_STATE (デフォルト): 操作は実行されません。 INSUFFICIENT_DATA: アラート内容はデータが不十分であることを示します。 OK: 法線。	KEEP_LAST_STATE
CompositeExpression	object	複数メトリックのアラート条件。説明単一メトリック条件と複数メトリック条件は相互排他であり、同時にセットできません。
Level	string	アラートレベル。有効な値: CRITICAL: 重大。 WARN: 警告。 INFO: 情報。	CRITICAL
ExpressionList	object
ExpressionList	array<object>	標準モードで作成されたアラート条件のリスト。
	object	なし。
MetricName	string	Alibaba Cloud サービスのメトリック名。	cpu_total
Period	integer	メトリックの集計期間。単位: 秒。	60
Statistics	string	メトリックの統計メソッド。有効な値: $Maximum: 最大値。 $Minimum: 最小値。 $Average: 平均値。 $Availability: アクティブなレート (通常、サイトモニタリングに使用されます)。説明 `$` はメトリックの統一プレフィックスです。サポートされている Alibaba Cloud サービスについては、クラウドサービス監視メトリクスを参照してください。	$Maximum
ComparisonOperator	string	しきい値の比較演算子。有効な値: GreaterThanOrEqualToThreshold: しきい値以上。 GreaterThanThreshold: しきい値より大きい。 LessThanOrEqualToThreshold: しきい値以下。 LessThanThreshold: しきい値より小さい。 NotEqualToThreshold: しきい値と等しくない。 GreaterThanYesterday: 前日の同時間の値より大きい。 LessThanYesterday: 前日の同時間の値より小さい。 GreaterThanLastWeek: 前週の同時間の値より大きい。 LessThanLastWeek: 前週の同時間の値より小さい。 GreaterThanLastPeriod: 前の期間の値より大きい。 LessThanLastPeriod: 前の期間の値より小さい。	GreaterThanOrEqualToThreshold
Threshold	string	アラートのしきい値。	90
ExpressionListJoin	string	複数メトリックアラート条件間の関係。有効な値: `&&`: すべてのメトリックがアラート条件を満たした場合にのみアラートがトリガーされます。ExpressionList 内のすべての式が `true` の場合にのみアラートがトリガーされます。 `\|\|`: いずれかのメトリックがアラート条件を満たした場合にアラートがトリガーされます。	\|\|
ExpressionRaw	string	式を使用して作成されたアラート条件。以下のシナリオがサポートされていますが、これらに限定されません: 特定のリソースにアラートブラックリストを設定します。たとえば、$instanceId != 'i-io8kfvcpp7x5**' ``&&`` $Average > 50 は、インスタンス `i-io8kfvcpp7x5` の `Average` が 50 を超えてもアラートがトリガーされないことを示します。特定のインスタンスに特別なアラートのしきい値を設定します。たとえば、`$Average > ($instanceId == 'i-io8kfvcpp7x5'? 80: 50)` は、インスタンス `i-io8kfvcpp7x5**` の `Average` が 80 を超えた場合にのみアラートがトリガーされ、他のインスタンスでは `Average` が 50 を超えた場合にアラートがトリガーされることを示します。しきい値を超えるインスタンスの数を制限します。たとえば、`count($Average > 20) > 3` は、`Average` が 20 を超えるインスタンスが 3 つ以上ある場合にのみアラートがトリガーされることを示します。	$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)
Times	integer	アラート通知が送信される前にアラート条件が満たされる必要がある回数。	3
Labels	object
Labels	array<object>	アラートルールのタグ。
	object	なし。
Key	string	アラートルールのタグキー。	cmsRuleKey
Value	string	アラートルールのタグ値。	cmsRuleValue
Prometheus	object	Prometheus アラート。説明このパラメーターは、ハイブリッドクラウドモニタリング用の Prometheus アラートルールを作成する場合にのみ設定してください。
PromQL	string	PromQL クエリ文。説明 PromQL クエリ文で取得されるデータはアラートデータです。この文にアラートのしきい値を含めてください。	CpuUsage{instanceId="xxxx"}[1m]>90
Level	string	アラートレベル。有効な値: CRITICAL: 重大。 WARN: 警告。 INFO: 情報。	CRITICAL
Times	integer	アラート通知が送信される前にアラート条件が満たされる必要がある回数。	3
Annotations	object
Annotations	array<object>	Prometheus アラートのアノテーション。アノテーションのキーと値はレンダリングされ、メトリックやアラートルールの理解に役立ちます。説明この機能は Prometheus の Annotation 機能と同等です。
	object	なし。
Key	string	アノテーションのキー。	summary
Value	string	アノテーションの値。	{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }
SendOK	boolean	回復アラートが無効かどうかを示します。有効な値: true (無効) および false (有効)。	true
ProductCategory	string	Alibaba Cloud サービスのタイプ。	slb
GmtCreate	integer	ルールが作成された時間。値は UNIX タイムスタンプです。	1760432061000
GmtUpdate	string	ルールが最後に更新された時間。値は UNIX タイムスタンプです。	1760432061000

例

成功レスポンス

JSONJSON

{
  "Code": 200,
  "Message": "The specified resource is not found.",
  "RequestId": "386C6712-335F-5054-930A-CC92B851ECBA",
  "Total": "1",
  "Success": true,
  "Alarms": {
    "Alarm": [
      {
        "SilenceTime": 86400,
        "MetricName": "cpu_total",
        "Webhook": "https://www.aliyun.com",
        "ContactGroups": "ECS_Alarm",
        "SourceType": "METRIC",
        "Namespace": "acs_ecs_dashboard",
        "MailSubject": "\"${serviceType}-${metricName}-${levelDescription} notification(${dimensions})\"",
        "NoEffectiveInterval": "00:00-05:30",
        "EffectiveInterval": "05:31-23:59",
        "RuleName": "Rule_01",
        "AlertState": "OK",
        "Period": "60",
        "RuleId": "applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****",
        "GroupName": "ECS_Group",
        "GroupId": "7301****",
        "Dimensions": "[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]",
        "EnableState": true,
        "Resources": "[{\\\"instanceId\\\":\\\"i-2ze2d6j5uhg20x47****\\\"}]",
        "Escalations": {
          "Info": {
            "ComparisonOperator": "GreaterThanOrEqualToThreshold",
            "PreCondition": "$Average>80",
            "Times": 3,
            "Threshold": "90",
            "Statistics": "Average"
          },
          "Warn": {
            "ComparisonOperator": "GreaterThanOrEqualToThreshold",
            "PreCondition": "$Average>80",
            "Times": 3,
            "Threshold": "90",
            "Statistics": "Average"
          },
          "Critical": {
            "ComparisonOperator": "GreaterThanOrEqualToThreshold",
            "PreCondition": "$Average>80",
            "Times": 3,
            "Threshold": "90",
            "Statistics": "Average"
          }
        },
        "NoDataPolicy": "KEEP_LAST_STATE",
        "CompositeExpression": {
          "Level": "CRITICAL",
          "ExpressionList": {
            "ExpressionList": [
              {
                "MetricName": "cpu_total",
                "Period": 60,
                "Statistics": "$Maximum",
                "ComparisonOperator": "GreaterThanOrEqualToThreshold",
                "Threshold": "90"
              }
            ]
          },
          "ExpressionListJoin": "||",
          "ExpressionRaw": "$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)",
          "Times": 3
        },
        "Labels": {
          "Labels": [
            {
              "Key": "cmsRuleKey",
              "Value": "cmsRuleValue"
            }
          ]
        },
        "Prometheus": {
          "PromQL": "CpuUsage{instanceId=\"xxxx\"}[1m]>90",
          "Level": "CRITICAL",
          "Times": 3,
          "Annotations": {
            "Annotations": [
              {
                "Key": "summary",
                "Value": "{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }"
              }
            ]
          }
        },
        "SendOK": true,
        "ProductCategory": "slb",
        "GmtCreate": 1760432061000,
        "GmtUpdate": "1760432061000"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	Invalid parameter.	参数错误
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidAuthorization	The Request is not authorization.
404	ResourceNotFound	The specified resource is not found.	未找到指定资源。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。