Updated on 2026-10-22 GMT+08:00

Reporting Events and Alarms

Function

This API is used to report events and alarms to AOM. It is also used to clear alarms.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

aom:alarm:put

Write

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
aom:alarm:put	Write	-	-	-	-

URI

PUT /v2/{project_id}/push/events

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
action	No	String	Requested action. If this parameter is not transferred or other values are transferred, an alarm or event is to be reported. By default, this parameter is left blank, indicating that an alarm or event is to be reported. clear: An alarm is to be cleared.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. For details, see Obtaining a Token.
Content-Type	Yes	String	Message body type or format. The specified type is application/json.
enterprise-project-id	No	String	ID of the enterprise project to which the alarm belongs. For details, see Obtaining an Enterprise Project ID. If this parameter is not transferred, the default enterprise project will be used (ID: 0).

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
events	Yes	Array of EventModel objects	Event or alarm details.

**Table 5** EventModel
Parameter	Mandatory	Type	Description
starts_at	No	Long	Time when an event or alarm is generated (UTC timestamp precise down to the millisecond). Example: 2024-10-16 16:03:01 needs to be converted to UTC timestamp 1702759381000 using a tool. This parameter needs to be specified if the value of action is left blank (which indicates that an event or alarm is to be reported).
ends_at	No	Long	Time when an event or alarm is cleared (UTC timestamp precise down to the millisecond). 0 (default): The alarm is not cleared. Example: 2024-10-16 16:03:01 needs to be converted to UTC timestamp 1702759381000 using a tool. This parameter needs to be specified if the value of action is set to clear.
timeout	No	Long	After how long will an alarm be automatically cleared. Max.: 15 days. Unit: ms. For example, if an alarm is cleared after 1 minute, set this parameter to 60000 If an alarm is cleared after 5 days, set this parameter to 7,200 × 60,000 (5 days × 24 hours × 60 minutes × 60,000 ms). By default, an alarm is cleared after 15 days. This parameter is not required when action is set to clear.
metadata	Yes	Map<String,String>	Details about an event or alarm to be reported or cleared, which is in the format of "key-value". When the action is clear, this field must be the same as that of the initially reported data. Mandatory fields: event_name: event or alarm name. It is of the string type. event_severity: event or alarm severity. It is of the string type. Range: Critical Major Minor Info event_type: event or alarm type. It is of the string type. Range: event alarm resource_provider: name of a cloud service corresponding to an event. It is of the string type. resource_type: resource type corresponding to an event. It is of the string type. resource_id: resource information corresponding to an event. It is of the string type. The value in metadata can contain 1 to 2,048 characters.
annotations	No	Map<String,Object>	Additional field for an event or alarm, which can be left blank.

Response Parameters

Status code: 204

None

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Error message.
error_type	String	Error type.
trace_id	String	Request ID.

Example Requests

Report an alarm named "test".

https://{EndPoint}/v2/{project_id}/push/events

{
  "events" : [ {
    "starts_at" : 1605232501000,
    "timeout" : 60000,
    "metadata" : {
      "event_name" : "test",
      "event_severity" : "Major",
      "event_type" : "alarm",
      "resource_provider" : "ecs",
      "resource_type" : "vm",
      "resource_id" : "ecs123"
    },
    "annotations" : {
      "alarm_probableCause_zh_cn" : "Possible Causes",
      "alarm_fix_suggestion_zh_cn" : "Suggestions",
      "message" : "Alarm Details"
    }
  } ]
}

Example Responses