PutCustomEventRule-阿里云帮助中心

Calls the PutCustomEventRule operation to create an alert rule for a custom event.

Operation description

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

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:PutCustomEventRule

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the application group. For information about how to obtain the ID, see DescribeCustomEventAttribute. Note A value of 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 If the alert rule ID already exists, the alert rule is modified. If the alert rule ID does not exist, an alert rule is created.	CustomRuleId1
RuleName	string	Yes	The name of the alert rule.	CustomeRule
EventName	string	Yes	The name of the custom event. For information about how to obtain the name, see DescribeCustomEventAttribute.	HostDown
ContactGroups	string	Yes	The alert contact group. 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.	https://www.aliyun.com
EffectiveInterval	string	No	The time period during which the alert rule is effective. Valid values: 00:00-23:59.	00:00-23:59
Period	string	No	The aggregation period of the monitoring data for the custom event. Unit: seconds. The value must be 60 or a multiple of 60. Default value: 300.	60
EmailSubject	string	No	The subject of the alert email.	ECS instance
Threshold	string	Yes	The alert threshold.	99
Level	string	Yes	The alert level. Valid values: CRITICAL WARN INFO	CRITICAL

Response elements

Element	Type	Description	Example
	object
Code	string	The 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

Success response

JSON format

{
  "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
400	%s	%s
499	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
204	%s	%s
403	%s	%s
206	%s	%s
404	%s	%s
503	%s	%s
406	%s	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.