DescribeMetricRuleList - Cloud Monitor - Alibaba Cloud ドキュメントセンター

アラートルールのリストをクエリします。

操作説明

このトピックでは、ご利用の Alibaba Cloud アカウントのすべてのアラートルールをクエリする方法の例を示します。応答では、ID が applyTemplate344cfd42-0f32-4fd6-805a-88d7908a**** の Rule_01 という名前のアラートルールが 1 つ返されます。

今すぐお試しください

この 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

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
MetricName	string	任意	メトリックの名前。メトリック名の取得方法の詳細については、DescribeMetricMetaList またはクラウドサービスのメトリックをご参照ください。注：複合メトリクスの場合、最初のメトリックによってのみ取得できます。	cpu_total
EnableState	boolean	任意	アラートルールの状態。有効な値： true：有効。 false：無効。	true
Namespace	string	任意	Alibaba Cloud サービスの名前空間。 Alibaba Cloud サービスの名前空間の取得方法の詳細については、DescribeMetricMetaList またはクラウドサービスのメトリックをご参照ください。	acs_ecs_dashboard
Page	integer	任意	ページ番号。 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	各ページで返されるエントリ数。 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。最大 20 個の ID を指定できます。複数の ID はコンマ (,) で区切ります。	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****

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

レスポンスフィールド

フィールド	型	説明	例
	object	なし。
Code	integer	ステータスコード。説明値が 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}通知（${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	情報レベルのアラートをトリガーするための条件。
ComparisonOperator	string	情報レベルのアラートのしきい値の比較演算子。有効な値： GreaterThanOrEqualToThreshold：以上。 GreaterThanThreshold：より大きい。 LessThanOrEqualToThreshold：以下。 LessThanThreshold：より小さい。 NotEqualToThreshold：等しくない。 GreaterThanYesterday：昨日の同時刻の値より大きい。 LessThanYesterday：昨日の同時刻の値より小さい。 GreaterThanLastWeek：先週の同時刻の値より大きい。 LessThanLastWeek：先週の同時刻の値より小さい。 GreaterThanLastPeriod：前のサイクルの値より大きい。 LessThanLastPeriod：前のサイクルの値より小さい。	GreaterThanOrEqualToThreshold
PreCondition	string	情報レベルのアラートの前提条件。このパラメーターは、`ComparisonOperator` が前日比または前週比の比較を示す値に設定されている場合に使用されます。たとえば、このパラメーターを `$Average>80` に、`ComparisonOperator` を `GreaterThanYesterday` に、`Threshold` を `10` に設定した場合、平均値が 80 を超え、前日比の増加が 10% のときにアラートがトリガーされます。説明 `$Average>0` において、`$Average` は `$metric-field-value` 形式のプレースホルダーです。CloudMonitor は、これを対応する統計値または元のメトリック値に置き換えます。	$Average>80
Times	integer	情報レベルのアラートが連続してトリガーされる回数。メトリック値が指定された連続回数しきい値を超えた場合にのみ、アラートがトリガーされます。	3
Threshold	string	情報レベルのアラートのしきい値。	90
Statistics	string	情報レベルのアラートの統計メソッド。	Average
Warn	object	警告レベルのアラートをトリガーするための条件。
ComparisonOperator	string	警告レベルのアラートのしきい値の比較演算子。有効な値： GreaterThanOrEqualToThreshold：以上。 GreaterThanThreshold：より大きい。 LessThanOrEqualToThreshold：以下。 LessThanThreshold：より小さい。 NotEqualToThreshold：等しくない。 GreaterThanYesterday：昨日の同時刻の値より大きい。 LessThanYesterday：昨日の同時刻の値より小さい。 GreaterThanLastWeek：先週の同時刻の値より大きい。 LessThanLastWeek：先週の同時刻の値より小さい。 GreaterThanLastPeriod：前のサイクルの値より大きい。 LessThanLastPeriod：前のサイクルの値より小さい。	GreaterThanOrEqualToThreshold
PreCondition	string	警告レベルのアラートの前提条件。このパラメーターは、`ComparisonOperator` が前日比または前週比の比較を示す値に設定されている場合に使用されます。たとえば、このパラメーターを `$Average>80` に、`ComparisonOperator` を `GreaterThanYesterday` に、`Threshold` を `10` に設定した場合、平均値が 80 を超え、前日比の増加が 10% のときにアラートがトリガーされます。説明 `$Average>0` において、`$Average` は `$metric-field-value` 形式のプレースホルダーです。CloudMonitor は、これを対応する統計値または元のメトリック値に置き換えます。	$Average>80
Times	integer	警告レベルのアラートが連続してトリガーされる回数。メトリック値が指定された連続回数しきい値を超えた場合にのみ、アラートがトリガーされます。	3
Threshold	string	警告レベルのアラートのしきい値。	90
Statistics	string	警告レベルのアラートの統計メソッド。	Average
Critical	object	重大レベルのアラートをトリガーするための条件。
ComparisonOperator	string	重大レベルのアラートのしきい値の比較演算子。有効な値： GreaterThanOrEqualToThreshold：以上。 GreaterThanThreshold：より大きい。 LessThanOrEqualToThreshold：以下。 LessThanThreshold：より小さい。 NotEqualToThreshold：等しくない。 GreaterThanYesterday：昨日の同時刻の値より大きい。 LessThanYesterday：昨日の同時刻の値より小さい。 GreaterThanLastWeek：先週の同時刻の値より大きい。 LessThanLastWeek：先週の同時刻の値より小さい。 GreaterThanLastPeriod：前のサイクルの値より大きい。 LessThanLastPeriod：前のサイクルの値より小さい。	GreaterThanOrEqualToThreshold
PreCondition	string	重大レベルのアラートの前提条件。このパラメーターは、`ComparisonOperator` が前日比または前週比の比較を示す値に設定されている場合に使用されます。たとえば、このパラメーターを `$Average>80` に、`ComparisonOperator` を `GreaterThanYesterday` に、`Threshold` を `10` に設定した場合、平均値が 80 を超え、前日比の増加が 10% のときにアラートがトリガーされます。説明 `$Average>0` において、`$Average` は `$metric-field-value` 形式のプレースホルダーです。CloudMonitor は、これを対応する統計値または元のメトリック値に置き換えます。	$Average>80
Times	integer	重大レベルのアラートが連続してトリガーされる回数。メトリック値が指定された連続回数しきい値を超えた場合にのみ、アラートがトリガーされます。	3
Threshold	string	重大レベルのアラートのしきい値。	90
Statistics	string	重大レベルのアラートの統計メソッド。	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	Prometheus クエリ言語 (PromQL) のクエリ文。説明 PromQL 文を使用してクエリされるデータはアラートデータです。文にアラートしきい値を含めてください。	CpuUsage{instanceId="xxxx"}[1m]>90
Level	string	アラートレベル。有効な値： CRITICAL：重大。 WARN：警告。 INFO：情報。	CRITICAL
Times	integer	アラート通知が送信される前にアラート条件が満たされる必要がある回数。	3
Annotations	object
Annotations	array<object>	Prometheus アラートがトリガーされると、アノテーションのキーと値がレンダリングされ、メトリックやアラートルールを理解するのに役立ちます。説明この機能は、Prometheus のアノテーション機能に相当します。
	object	なし。
Key	string	アノテーションのキー。	summary
Value	string	アノテーションの値。	{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }
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}通知（${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 }} }"
              }
            ]
          }
        },
        "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.	The specified resource is not found.

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

変更履歴

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