DescribeAlertLogList によるアラート履歴のクエリ - CMS

DescribeAlertLogList 操作はアラート履歴をクエリします。

操作説明

この操作は、過去 1 年間のアラート履歴をクエリします。

このトピックでは、product ディメンションによって Elastic Compute Service (ECS) のアラート履歴をクエリする方法の例を示します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
StartTime	integer	任意	クエリする時間範囲の開始。この値は UNIX タイムスタンプです。単位: ミリ秒。過去 1 年間のアラート履歴をクエリできます。指定した時間範囲が 1 年以上前の場合、`AlertLogList` パラメーターの値は空になります。説明 `StartTime` と `EndTime` の間の間隔は 15 日を超えることはできません。両方のパラメーターを指定するか、両方を空のままにする必要があります。空のままにすると、過去 15 分間のアラート履歴がクエリされます。	1609988009694
EndTime	integer	任意	クエリする時間範囲の終了。この値は UNIX タイムスタンプです。単位: ミリ秒。過去 1 年間のアラート履歴をクエリできます。指定した時間範囲が 1 年以上前の場合、`AlertLogList` パラメーターの値は空になります。説明 `StartTime` と `EndTime` の間の間隔は 15 日を超えることはできません。両方のパラメーターを指定するか、両方を空のままにする必要があります。空のままにすると、過去 15 分間のアラート履歴がクエリされます。	1610074409694
PageNumber	integer	任意	ページ番号。デフォルト値: 1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値: 10。	10
SearchKey	string	任意	アラート履歴の検索に使用するキーワード。	alert
GroupId	string	任意	アプリケーショングループの ID。	7301****
Namespace	string	任意	クラウドサービスの名前空間。説明詳細については、「メトリクス」をご参照ください。	acs_ecs_dashboard
Product	string	任意	クラウドサービス名の略語。クラウドサービス名の略語の取得方法の詳細については、「DescribeProductsOfActiveMetricRule」をご参照ください。	ECS
Level	string	任意	アラートレベルと通知方法。有効な値: P2: 電話、ショートメッセージ、メール、および DingTalk チャットボット。 P3: ショートメッセージ、メール、および DingTalk チャットボット。	P4
SendStatus	string	任意	アラートステータス。有効な値: 0: アラートがトリガーまたはクリアされます。 1: アラートルールは無効です。 2: アラートはミュート期間中です。 3: ホストは再起動中です。 4: アラート通知は送信されません。このパラメーターの値が 0 で、`Level` の値が P4 の場合、アラートがトリガーされます。このパラメーターの値が 0 で、`Level` の値が OK の場合、アラートはクリアされます。	0
ContactGroup	string	任意	アラート連絡グループ。	ECS_Group
RuleName	string	任意	アラートルールの名前。	test123
MetricName	string	任意	メトリックの名前。説明詳細については、「メトリクス」をご参照ください。	IntranetInRate
LastMin	string	任意	ログをクエリする期間。単位: 分。	360
GroupBy	string	任意	アラート履歴データをグループ化するためのディメンション。これは、SQL の GROUP BY 句に似ています。有効な値: `product`: クラウドサービス別にグループ化します。 `level`: アラートレベル別にグループ化します。 `groupId`: アプリケーショングループ別にグループ化します。 `contactGroup`: アラート連絡グループ別にグループ化します。 `product,metricName`: クラウドサービスとメトリック別にグループ化します。	product
RuleId	string	任意	アラートルールの ID。アラートルール ID のクエリ方法の詳細については、「DescribeMetricRuleList」をご参照ください。	bc369e8_30f87e517ed2fc****
SourceType	string	任意	アラートルールのタイプ。値を METRIC に設定します。METRIC は、しきい値ベースのアラートルールを示します。	METRIC
EventType	string	任意	アラートのタイプ。有効な値: TRIGGERED: アラートがトリガーされます。 RESOLVED: アラートはクリアされます。	TRIGGERED

詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object	なし。
RequestId	string	リクエスト ID。	1C4A3709-BF52-42EE-87B5-7435F0929585
Success	boolean	操作が成功したかどうかを示します。有効な値: true false	true
Code	string	状態コード。説明ステータスコード 200 は、操作が成功したことを示します。	200
Message	string	エラーメッセージ。	The specified resource is not found.
PageNumber	integer	ページ番号。	1
PageSize	integer	ページごとに返されるエントリ数。	10
AlertLogList	array<object>	アラート履歴。
	array<object>	なし。
MetricName	string	メトリックの名前。	cpu_total
EventName	string	イベントの名前。	IOHang
Product	string	クラウドサービスの識別子。有効な値: クラウドサービスが Alibaba Cloud サービスの場合、値はクラウドサービス名の略語です。例: ECS。クラウドサービスが Alibaba Cloud サービスでない場合、値は `acs_Service keyword` 形式です。例: acs_networkmonitor。	ECS
BlackListUUID	string	ヒットしたブラックリストポリシーの UUID。	8410dbbd-7d30-41c5-94cb-****
Message	string	アラートに関する情報。値は JSON 文字列です。	{"alertName":"e47aa0ac-4076-44db-a47d-d1083968****_Availability"}
Namespace	string	クラウドサービスの名前空間。	acs_ecs_dashboard
LevelChange	string	アラートレベルの変更。有効な値: `P4->OK`: アラートは P4 からクリアされます。 `P4->P4`: P4 レベルのアラートは持続します。	P4->OK
InstanceId	string	リソース ID。	i-m5e1qg6uo38rztr4****
RuleName	string	アラートルールの名前。	CPU使用率
RuleId	string	アラートルールの ID。	d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime
BlackListName	string	ヒットしたブラックリストポリシーの名前。	Black_Test
GroupName	string	アプリケーショングループの名前。	ECS_Instances
GroupId	string	アプリケーショングループの ID。	7301****
AlertTime	string	アラートがトリガーされたときのタイムスタンプ。単位: ミリ秒。	1610043776621
InstanceName	string	リソースの名前。	portalHost
BlackListDetail	string	ヒットしたブラックリストポリシーの詳細。	{"id":12**,"metricProject":"acs_ecs_dashboard","userId":173651113438,"uuid":"8410dbbd-7d30-41c5-94cb-","name":"alert-","productCategory":"ecs","instances":[{"instanceId":"i-m5e1qg6uo38rztr4**"}],"metrics":null,"scopeType":"USER","scopeValue":"","startTime":"0001-01-01T00:00:00Z","endTime":"9999-12-31T23:59:59.999999999+08:00","effectiveTime":null,"isEnable":true,"status":1,"gmtCreate":"2021-11-02T16:35:59+08:00","gmtModified":"2021-11-02T16:35:59+08:00","loadTime":"2021-11-02T16:36:15.213072177+08:00"}
Level	string	アラートレベルと対応する通知方法を指定します。有効な値は次のとおりです: P4: メールと DingTalk ロボット。 OK: アラートなし。	P4
SendStatus	string	アラートステータス。有効な値: 0: アラートがトリガーまたはクリアされます。 1: アラートルールは無効です。 2: アラートはミュート期間中です。 3: ホストは再起動中です。 4: アラート通知は送信されません。このパラメーターの値が 0 で、`Level` の値が P4 の場合、アラートがトリガーされます。このパラメーターの値が 0 で、`Level` の値が OK の場合、アラートはクリアされます。	0
ExtendedInfo	array<object>	アラートの拡張情報。
	object	なし。
Name	string	拡張フィールドの名前。	userId
Value	string	拡張フィールドの値。	100931896542****
Dimensions	array<object>	アラートをトリガーするリソースのディメンション。
	object	なし。
Key	string	ディメンションのキー。	instanceId
Value	string	ディメンションの値。	i-m5e1qg6uo38rztr4****
WebhookList	array<object>	コールバック URL のリスト。
	object	なし。
code	string	アラートコールバックのステータスコード。	200
url	string	コールバック URL。	https://www.aliyun.com/webhook.html
message	string	アラートコールバックに対して返されたメッセージ。	success
DingdingWebhookList	array	アラート連絡先の Webhook URL のリスト。
	string	アラート連絡先の Webhook URL のリスト。	https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****
ContactOnCallList	array	アラート連絡先の電話番号のリスト。
	string	アラート連絡先の電話番号のリスト。説明このパラメーターは、中国サイト (aliyun.com) でのみ使用できます。	1368888****
ContactMailList	array	アラート連絡先のメールアドレスのリスト。
	string	アラート連絡先のメールアドレスのリスト。	username@example.com
ContactGroups	array	アラート連絡グループのリスト。
	string	アラート連絡グループ。	ECS_Group
ContactALIIWWList	array	アラート連絡先の TradeManager ID のリスト。
	string	アラート連絡先の TradeManager ID のリスト。説明このパラメーターは、中国サイト (aliyun.com) でのみ使用できます。	Alice
ContactSMSList	array	ショートメッセージ受信者のリスト。
	string	ショートメッセージ受信者のリスト。説明このパラメーターは、中国サイト (aliyun.com) でのみ使用できます。	1368888****
ContactDingList	array	アラート連絡先の DingTalk チャットボットのリスト。
	string	アラート連絡先の DingTalk チャットボットのリスト。	CloudMonitor
SendDetail	object	アラート通知の詳細。
ResultCode	string	アラート通知のステータス。 success: 通知は送信されます。エラーコード: 構成でエラーが発生した場合、通知は送信されず、エラーコードが返されます。	success
ChannelResultList	array<object>	各チャンネルを通じて送信されるアラート通知のリスト。
	array<object>	各チャンネルを通じて送信されるアラート通知の結果。
Channel	string	アラート通知の送信先チャンネル。有効な値: MAIL: メール SMS: ショートメッセージ WEBHOOK: Webhook SLS: Simple Log Service ONCALL: 電話 FC: Function Compute MNS: Message Service (MNS)	MAIL
ResultList	array<object>	チャンネルを通じて送信されるアラート通知の結果のリスト。
	object	チャンネルを通じて送信されるアラート通知の結果。
Code	string	状態コード。 `Channel` が `WEBHOOK` に設定されている場合、ステータスコードは 200 または 500 です。 `Channel` が `MAIL`、`SMS`、`SLS`、`ONCALL`、`FC`、または `MNS` に設定されている場合、このパラメーターは返されないか、空です。	200
RequestId	string	別のクラウドサービスに送信されるリクエストの ID。	0BDAF8A8-04DC-5F0C-90E4-724D42C4****
Success	boolean	呼び出しの結果。 true: 呼び出しは成功です。 false: 呼び出しは失敗です。	true
Detail	string	返された結果の詳細。	{ }
notifyTargetList	array	通知チャンネルのリスト。
	string	通知チャンネルのリスト。	MAIL
Escalation	object	トリガーされたアラートルール。
Expression	string	アラートルールの説明。説明これは、アラートルールをトリガーするための条件です。モニタリングデータが条件を満たすと、アラートがトリガーされます。	$Average<90
Times	integer	再試行回数。	1
Level	string	アラートレベルと通知方法。有効な値: P2: 電話、ショートメッセージ、メール、および DingTalk チャットボット。 P3: ショートメッセージ、メール、および DingTalk チャットボット。	P4
SendResultList	array<object>	アラート通知結果のリスト。
	object	アラート通知結果のリスト。
Key	string	アラート通知の送信先チャンネル。有効な値: MAIL: メール ALIIM: TradeManager SMS: ショートメッセージ CALL: 電話 DING: DingTalk チャットボット Merged: マージされたアラート	MAIL
Value	array	通知オブジェクト。
	string	通知オブジェクト。	username@example.com
LogId	string	ログ ID。	7510**::e8a472a0-46ae-4ac0-84b1-e46be368**

例

成功レスポンス

JSONJSON

{
  "RequestId": "1C4A3709-BF52-42EE-87B5-7435F0929585",
  "Success": true,
  "Code": "200",
  "Message": "The specified resource is not found.",
  "PageNumber": 1,
  "PageSize": 10,
  "AlertLogList": [
    {
      "MetricName": "cpu_total",
      "EventName": "IOHang",
      "Product": "ECS",
      "BlackListUUID": "8410dbbd-7d30-41c5-94cb-****",
      "Message": "{\"alertName\":\"e47aa0ac-4076-44db-a47d-d1083968****_Availability\"}",
      "Namespace": "acs_ecs_dashboard",
      "LevelChange": "P4->OK",
      "InstanceId": "i-m5e1qg6uo38rztr4****",
      "RuleName": "CPU使用率",
      "RuleId": "d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime",
      "BlackListName": "Black_Test",
      "GroupName": "ECS_Instances",
      "GroupId": "7301****",
      "AlertTime": "1610043776621",
      "InstanceName": "portalHost",
      "BlackListDetail": "{\"id\":12****,\"metricProject\":\"acs_ecs_dashboard\",\"userId\":173651113438****,\"uuid\":\"8410dbbd-7d30-41c5-94cb-****\",\"name\":\"alert-****\",\"productCategory\":\"ecs\",\"instances\":[{\"instanceId\":\"i-m5e1qg6uo38rztr4****\"}],\"metrics\":null,\"scopeType\":\"USER\",\"scopeValue\":\"\",\"startTime\":\"0001-01-01T00:00:00Z\",\"endTime\":\"9999-12-31T23:59:59.999999999+08:00\",\"effectiveTime\":null,\"isEnable\":true,\"status\":1,\"gmtCreate\":\"2021-11-02T16:35:59+08:00\",\"gmtModified\":\"2021-11-02T16:35:59+08:00\",\"loadTime\":\"2021-11-02T16:36:15.213072177+08:00\"}",
      "Level": "P4",
      "SendStatus": "0",
      "ExtendedInfo": [
        {
          "Name": "userId",
          "Value": "100931896542****"
        }
      ],
      "Dimensions": [
        {
          "Key": "instanceId",
          "Value": "i-m5e1qg6uo38rztr4****"
        }
      ],
      "WebhookList": [
        {
          "code": "200",
          "url": "https://www.aliyun.com/webhook.html",
          "message": "success"
        }
      ],
      "DingdingWebhookList": [
        "https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****"
      ],
      "ContactOnCallList": [
        "1368888****"
      ],
      "ContactMailList": [
        "username@example.com"
      ],
      "ContactGroups": [
        "ECS_Group"
      ],
      "ContactALIIWWList": [
        "Alice"
      ],
      "ContactSMSList": [
        "1368888****"
      ],
      "ContactDingList": [
        "CloudMonitor"
      ],
      "SendDetail": {
        "ResultCode": "success",
        "ChannelResultList": [
          {
            "Channel": "MAIL",
            "ResultList": [
              {
                "Code": "200",
                "RequestId": "0BDAF8A8-04DC-5F0C-90E4-724D42C4****",
                "Success": true,
                "Detail": "{ }",
                "notifyTargetList": [
                  "MAIL"
                ]
              }
            ]
          }
        ]
      },
      "Escalation": {
        "Expression": "$Average<90",
        "Times": 1,
        "Level": "P4"
      },
      "SendResultList": [
        {
          "Key": "MAIL",
          "Value": [
            "username@example.com"
          ]
        }
      ],
      "LogId": "7510****::e8a472a0-46ae-4ac0-84b1-e46be368****"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ParameterInvalid	Parameter invalid.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

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

変更履歴

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