DescribeEventRuleAttribute - Cloud Monitor - Alibaba Cloud Documentation Center

You can call the DescribeEventRuleAttribute operation to query the details of a specified event-triggered alert rule.

Operation description

This topic provides an example of how to query the details of the event-triggered alert rule named testRule.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeEventRuleAttribute

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RuleName	string	Yes	The name of the event-triggered alert rule. For more information, see DescribeEventRuleList.	testRule
SilenceTime	string	No	The mute period. Unit: seconds. Default value: 86400 (1 day). Note If monitoring data continuously exceeds the alert threshold, an alert notification is sent only once during a mute period.	86400

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. Note A value of 200 indicates that the request was successful.	200
Message	string	The error message.	The alert does not exist.
RequestId	string	The request ID.	9AA3F210-C03D-4C86-8DB6-21C84FF692A1
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true
Result	object	The details of the event-triggered alert rule.
EventType	string	The event type. Valid values: SYSTEM: system event. CUSTOM: custom event.	SYSTEM
GroupId	string	The ID of the application group.	3607****
Name	string	The name of the event-triggered alert rule.	test_DefaultEventRule_7378****
Description	string	The description of the event-triggered alert rule.	Default group event rule.
State	string	The status of the event-triggered alert rule. Valid values: ENABLED: enabled. DISABLED: disabled.	ENABLED
EventPattern	object	The event pattern, which describes the conditions that trigger an event.
Product	string	The name of the cloud product.	CloudMonitor
LevelList	object
LevelList	array	A list of levels for the event-triggered alert rule.
	string	The level of the event-triggered alert rule. Valid values: CRITICAL: critical. WARN: warning. INFO: information.	["CRITICAL","WARN"]
StatusList	object
StatusList	array	A list of statuses for the event-triggered alert rule.
	string	The event status.	Running
NameList	object
NameList	array	A list of names for the event-triggered alert rule.
	string	The event name.	Agent_Status_Running
EventTypeList	object
EventTypeList	array	A list of types for the event-triggered alert rule.
	string	The type of the event-triggered alert rule. An asterisk (`*`) indicates that all types of alert rules are matched.	*
SQLFilter	string	Filters logs based on a SQL expression. An alert is triggered if the conditions are met.	ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222
KeywordFilterObj	object	The keywords used for filtering.
Keywords	object
keyword	array	A list of keywords that are used to match events.
	string	The keyword.	VMException
Relation	string	The relationship between multiple keywords. Valid values: OR: The logical OR. NOT: The logical NOT. This matches all events that do not contain the specified keywords.	OR

Examples

Success response

JSON format

{
  "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"
      }
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameterValue	Illegal parameters.	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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.