DescribeEventRuleAttribute API によるイベントトリガーアラートルール詳細の取得 - CMS - Alibaba Cloud - Cloud Monitor

DescribeEventRuleAttribute 操作を呼び出して、指定されたイベントトリガーアラートルールの詳細を照会します。

操作説明

この Topic では、イベントトリガーアラートルール testRule の詳細をクエリする例を示します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RuleName	string	必須	イベントトリガーアラートルールの名前。イベントトリガーアラートルールの名前を取得する方法については、 DescribeEventRuleList を参照してください。	testRule
SilenceTime	string	任意	ミュート期間。単位: 秒。デフォルト値: 86400 (1 日)。説明モニタリングデータがアラートルールのしきい値を継続的に超えた場合、各ミュート期間内にアラート通知は 1 回のみ送信されます。	86400

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

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	状態コード。説明 200 は成功を示します。	200
Message	string	エラーメッセージ。	The alert does not exist.
RequestId	string	リクエスト ID。	9AA3F210-C03D-4C86-8DB6-21C84FF692A1
Success	boolean	操作が成功したかどうかを示します。有効な値: true: 操作が成功しました。 false: 操作が失敗しました。	true
Result	object	イベントトリガーアラートルールの詳細。
EventType	string	イベントタイプ。有効な値: SYSTEM: システムイベント。 CUSTOM: カスタムイベント。	SYSTEM
GroupId	string	アプリケーショングループ ID。	3607****
Name	string	イベントトリガーアラートルールの名前。	test_DefaultEventRule_7378****
Description	string	イベントトリガーアラートルールの説明。	Default group event rule.
State	string	イベントトリガーアラートルールのステータス。有効な値: ENABLED: 有効。 DISABLED: 無効。	ENABLED
EventPattern	object	イベントパターン。イベントのトリガー条件を記述します。
Product	string	クラウドプロダクトの名前。	CloudMonitor
LevelList	object
LevelList	array	イベントトリガーのアラートルールのレベルのリスト。
	string	イベントトリガーのアラートルールのレベル。有効な値: CRITICAL: 重大。 WARN: 警告。 INFO: 情報。	["CRITICAL","WARN"]
StatusList	object
StatusList	array	イベントトリガーのアラートルールのステータスのリスト。
	string	イベントステータス。	Running
NameList	object
NameList	array	イベントトリガーのアラートルールの名前のリスト。
	string	イベント名。	Agent_Status_Running
EventTypeList	object
EventTypeList	array	イベントトリガーのアラートルールのタイプのリスト。
	string	イベントトリガーのアラートルールのタイプ。アスタリスク (`*`) は、すべてのアラートルールタイプが一致することを示します。	*
SQLFilter	string	SQL 式に基づいてログをフィルターします。条件が満たされると、アラートがトリガーされます。	ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222
KeywordFilterObj	object	フィルタリングに使用されるキーワード。
Keywords	object
keyword	array	イベントを照合するために使用されるキーワードのリスト。
	string	キーワード。	VMException
Relation	string	複数のキーワード間の関係。有効な値: OR: 論理 OR。 NOT: 論理 NOT。指定されたキーワードを含まないすべてのイベントに一致します。	OR

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "The alert does not exist.",
  "RequestId": "9AA3F210-C03D-4C86-8DB6-21C84FF692A1",
  "Success": true,
  "Result": {
    "EventType": "SYSTEM",
    "GroupId": "3607****",
    "Name": "test_DefaultEventRule_7378****",
    "Description": "Default group event rule.",
    "State": "ENABLED",
    "EventPattern": {
      "Product": "CloudMonitor",
      "LevelList": {
        "LevelList": [
          "[\"CRITICAL\",\"WARN\"]    "
        ]
      },
      "StatusList": {
        "StatusList": [
          "Running"
        ]
      },
      "NameList": {
        "NameList": [
          "Agent_Status_Running"
        ]
      },
      "EventTypeList": {
        "EventTypeList": [
          "*"
        ]
      },
      "SQLFilter": "ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222",
      "KeywordFilterObj": {
        "Keywords": {
          "keyword": [
            "VMException"
          ]
        },
        "Relation": "OR"
      }
    }
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameterValue	Illegal parameters.	不正なパラメータ。
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	%s	%s

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

変更履歴

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