Querying Events and Alarms¶

Function¶

This API is used to query events and alarms of a user.

URI¶

POST /v2/{project_id}/events

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID obtained from IAM. Generally, a project ID contains 32 characters.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
type	No	String	Type of information to be queried. active_alert: Active alarms are to be queried. history_alert: Historical alarms are to be queried. If this parameter is not transferred or other values are transferred, information that meets the specified search criteria will be returned. Enumeration values: history_alert active_alert

Request Parameters¶

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM.
Content-Type	Yes	String	Content type, which is application/json. Enumeration values: application/json

**Table 4** Request body parameters¶
Parameter	Mandatory	Type	Description
time_range	Yes	String	Time range specified to query data of the last N minutes when the client time is inconsistent with the server time. It can also be used to accurately query the data of a specified period. Example: -1.-1.60: indicates that the data of the latest 60 minutes is queried. This query is based on the server time regardless of the current client time. 1650852000000.1650852300000.5: indicates the five minutes from 10:00:00 to 10:05:00 on April 25, 2022 GMT+08:00. Format: startTimeInMillis.endTimeInMillis.durationInMinutes Parameter description: startTimeInMillis: Start time of the query, in milliseconds. If this parameter is set to -1, the server calculates the start time as follows: endTimeInMillis - durationInMinutes x 60 x 1000. For example, -1.1650852300000.5 is equivalent to 1650852000000.1650852300000.5. endTimeInMillis: End time of the query, in milliseconds. If this parameter is set to -1, the server calculates the end time as follows: startTimeInMillis + durationInMinutes x 60 x 1000. If the calculated end time is later than the current system time, the current system time is used. For example, 1650852000000.-1.5 is equivalent to 1650852000000.1650852300000.5. durationInMinutes: Time span, in minutes. The value must be greater than 0 and greater than or equal to the result of "(endTimeInMillis - startTimeInMillis)/(60 x 1000) - 1". If both the start time and end time are set to -1, the system sets the end time to the current UTC time (in milliseconds) and calculates the start time as follows: endTimeInMillis - durationInMinutes x 60 x 1000. For example, -1.-1.60 indicates the latest 60 minutes. Constraint: In a single request, the following condition must be met: durationInMinutes x 60/period <= 1440
step	No	Long	Statistical step (unit: ms). For example, if the statistical step is one minute, set this parameter to 60,000.
search	No	String	Field specified for fuzzy query, which can be left blank. If this field is not left blank, fuzzy query can be performed accordingly. In that case, the metadata field is mandatory.
sort	No	sort object	Sorting order, which can be left blank.
metadata_relation	No	Array of RelationModel objects	Combination of search criteria, which can be left blank.

**Table 5** sort¶
Parameter	Mandatory	Type	Description
order_by	No	Array of strings	List of sorted fields. Fields in this list are sorted based on the specified order.
order	No	String	Sorting order. asc: ascending order. desc: descending order. Enumeration values: asc desc

**Table 6** RelationModel¶
Parameter	Mandatory	Type	Description
key	No	String	Key specified for query, which corresponds to the key in the metadata.
value	No	Array of strings	Value of the specified key in the search criterion.
relation	No	String	Relationship between search criteria. Values: AND: All criteria must be met. OR: One of the criteria needs to be met. NOT: None of the criteria can be met. Enumeration values: AND OR NOT

Response Parameters¶

Status code: 200

**Table 7** Response body parameters¶
Parameter	Type	Description
events	Array of EventModel objects	Event or alarm details.

**Table 8** EventModel¶
Parameter	Type	Description
starts_at	Long	Time when an event or alarm is generated (CST timestamp precise down to the millisecond).
ends_at	Long	Time when an event or alarm is cleared (CST timestamp precise down to the millisecond). 0: The event or alarm is not deleted.
timeout	Long	Duration (in milliseconds) at which an alarm is automatically cleared. For example, if an alarm needs to be automatically cleared in one minute, set this parameter to 60000. The default value is 3 days (that is, 3 days x 24 hours x 60 minutes x 1000 ms = 4,320,000 ms).
metadata	Map<String,String>	Details of an event or alarm. The value is a key-value pair. The following fields are mandatory: event_name: event or alarm name, which is a string. event_severity: event severity, which is an enumerated value with string elements. Value: Critical, Major, Minor, or Info. event_type: event type, which is an enumerated value with string elements. Value: event or alarm. resource_provider: name of a cloud service corresponding to an event, which is a string. resource_type: resource type corresponding to an event, which is a string. resource_id: resource ID corresponding to an event, which is a string.
annotations	Map<String,String>	Additional field for an event or alarm, which can be left blank.
attach_rule	Map<String,String>	Reserved field for an event or alarm, which can be left blank.
id	String	Event or alarm ID, which is automatically generated by the system.

Status code: 400

**Table 9** Response body parameters¶
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Error description.
error_type	String	API call failure type.

Status code: 401

**Table 10** Response body parameters¶
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Error description.
error_type	String	API call failure type.

Status code: 403

**Table 11** Response body parameters¶
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Error description.
error_type	String	API call failure type.

Status code: 500

**Table 12** Response body parameters¶
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Error description.
error_type	String	API call failure type.

Status code: 503

**Table 13** Response body parameters¶
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Error description.
error_type	String	API call failure type.

Example Requests¶

Query the events and alarms of a specified user.

https://{endpoint}/v2/{project_id}/events

{
  "time_range" : "-1.-1.30",
  "metadata_relation" : [ {
    "key" : "event_type",
    "relation" : "AND",
    "value" : [ "alarm" ]
  }, {
    "key" : "event_severity",
    "relation" : "AND",
    "value" : [ "Critical", "Major", "Minor", "Info" ]
  } ],
  "search" : "",
  "sort" : {
    "order_by" : [ "starts_at" ],
    "order" : "desc"
  }
}

Example Responses¶

Status code: 200

OK: The request is successful.

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

Status code: 400

Bad Request: The request is invalid. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.0400",
  "error_message" : "param error",
  "error_type" : "SC_BAD_REQUEST"
}

Status code: 401

Unauthorized: The authentication information is incorrect or invalid.

{
  "error_code" : "AOM.0401",
  "error_message" : "you dont have permission",
  "error_type" : "SC_UNAUTHORIZED"
}

Status code: 403

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.0403",
  "error_message" : "you dont have permission",
  "error_type" : "SC_FORBIDDEN"
}

Status code: 500

Internal Server Error: The server is able to receive the request but unable to understand the request.

{
  "error_code" : "AOM.0500",
  "error_message" : "SC_INTERNAL_SERVER_ERROR",
  "error_type" : "SC_INTERNAL_SERVER_ERROR"
}

Status code: 503

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.0503",
  "error_message" : "SC_NOT_IMPLEMENTED",
  "error_type" : "SC_NOT_IMPLEMENTED"
}

Status Codes¶

Status Code	Description
200	OK: The request is successful.
400	Bad Request: The request is invalid. The client should not repeat the request without modifications.
401	Unauthorized: The authentication information is incorrect or invalid.
403	Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.
500	Internal Server Error: The server is able to receive the request but unable to understand the request.
503	Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

Error Codes¶

See Error Codes.

last updated: 2024-05-18 01:59