Queries the details of an event-triggered alert rule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeEventRuleAttribute

The operation that you want to perform. Set the value to DescribeEventRuleAttribute.

RuleName String Yes testRule

The name of the event-triggered alert rule.

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code. The status code 200 indicates that the call was successful.

Message String success

The returned message.

RequestId String 9AA3F210-C03D-4C86-8DB6-21C84FF692A1

The ID of the request.

Result N/A N/A

The details of the alert rule.

Description String Event monitoring

The description of the alert rule.

EventPattern N/A N/A

The trigger condition of the event.

LevelList List ["CRITICAL","WARN","INFO"]

The levels of alerts. Valid values: CRITICAL, WARN, and INFO.

LevelList N/A N/A

The level of the alert. Valid values: CRITICAL, WARN, and INFO.

NameList List *

The names of events.

NameList N/A N/A

The name of the event.

Product String CloudMonitor

The name of the service.

StatusList List XX

The statuses of events.

StatusList N/A N/A

The status of the event.

EventType String SYSTEM

The type of the event. Valid values: SYSTEM and CUSTOM.

GroupId String 123456

The ID of the application group.

Name String eventName1

The name of the event-triggered alert rule.

State String ENABLED

The status of the alert rule. Valid values: ENABLED and DISABLED.

Success Boolean true

Indicates whether the call was successful.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeEventRuleAttribute
&RuleName=testRule
&<Common request parameters>

Sample success responses

XML format

<DescribeEventRuleAttributeResponse>
      <Result>
            <Name>newXXX</Name>
            <State>ENABLED</State>
            <EventPattern>
                  <Product>CloudMonitor</Product>
                  <LevelList>
                        <LevelList>CRITICAL</LevelList>
                        <LevelList>WARN</LevelList>
                        <LevelList>INFO</LevelList>
                  </LevelList>
                  <NameList>
                        <NameList>Group_AddResourcesFailed_QuotaReached</NameList>
                        <NameList>Agent_Status_Stopped</NameList>
                        <NameList>Agent_Status_Running</NameList>
                  </NameList>
            </EventPattern>
            <EventType>SYSTEM</EventType>
      </Result>
      <RequestId>E3E23D87-4AA7-4F1B-94DE-827D84661F64</RequestId>
      <Success>true</Success>
      <Code>200</Code>   
</DescribeEventRuleAttributeResponse>

JSON format

{
	"Result":{
		"Name":"newXXX",
		"State":"ENABLED",
		"EventPattern":{
			"Product":"CloudMonitor",
			"LevelList":{
				"LevelList":[
					"CRITICAL",
					"WARN",
					"INFO"
				]
			},
			"NameList":{
				"NameList":[
					"Group_AddResourcesFailed_QuotaReached",
					"Agent_Status_Stopped",
					"Agent_Status_Running"
				]
			}
		},
		"EventType":"SYSTEM"
	},
	"RequestId":"E3E23D87-4AA7-4F1B-94DE-827D84661F64",
	"Success":true,
	"Code":"200"
}

Error codes

For a list of error codes, visit the API Error Center.