PutCustomEventRule - CloudMonitor - Alibaba Cloud Documentation Center

Operation description

Before you call this operation, call the PutCustomEvent operation to report the monitoring data of the custom event. For more information, see PutCustomEvent .

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the application group. For more information about how to obtain the group ID, see DescribeCustomEventAttribute . Note The value 0 indicates that the reported custom event does not belong to any application Group.	7378****
RuleId	string	Yes	The ID of the alert rule. Note You can specify an existing ID to modify the corresponding alert rule or specify a new ID to create an alert rule.	CustomRuleId1
RuleName	string	Yes	The name of the alert rule.	CustomeRule
EventName	string	Yes	The name of the custom event. For more information about how to obtain the event name, see DescribeCustomEventAttribute .	HostDown
ContactGroups	string	Yes	The alert contact group that receives alert notifications. Separate multiple contact groups with commas (,).	ECS_Group
Webhook	string	No	The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.	https://www.aliyun.com
EffectiveInterval	string	No	The time period during which the alert rule is effective. Valid values: 00:00 to 23:59.	00:00-23:59
Period	string	No	The cycle that is used to aggregate monitoring data of the custom event. Unit: seconds. Set the value to an integral multiple of 60. Default value: 300.	60
EmailSubject	string	No	The subject of the alert notification email.
Threshold	string	Yes	The alert threshold.	99
Level	string	Yes	The level of the alert. Valid values: CRITICAL: critical issue WARN: warning INFO: information	CRITICAL

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code. Note The value 200 indicates that the call was successful.	200
Message	string	The error message.	The request has failed due to a temporary failure of the server.
RequestId	string	The ID of the request.	AD5DCD82-BD1C-405F-BAED-32302DE9F498
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "The request has failed due to a temporary failure of the server.",
  "RequestId": "AD5DCD82-BD1C-405F-BAED-32302DE9F498",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
403	%s	%s
500	InternalError	The request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history