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
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| cms:PutCustomEventRule | create |
|
| none |
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 |
Response parameters
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 |
|---|