Help Center> Application Operations Management> API Reference> API> Alarm> Reporting Events and Alarms
View PDF

Reporting Events and Alarms

Function

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

URI

PUT /v2/{project_id}/push/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

action

No

String

Requested action. clear: The alarm is to be cleared. If this parameter is not transferred or other values are transferred, the alarm is reported by default.

Enumeration values:

  • clear

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.

x-enterprise-prject-id

No

String

ID of the enterprise project to which the alarm belongs.
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 (CST timestamp precise down to the millisecond).

ends_at

No

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

No

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

No

Object

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

No

Object

Additional field for an event or alarm, which can be left blank.

attach_rule

No

Object

Reserved field for an event or alarm, which can be left blank.

id

No

String

Event or alarm ID, which is automatically generated by the system.

Response Parameters

None

Example Requests

Report an alarm named "test".

https://{EndPoint}/v2/{project_id}/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" : "Handling suggestions",
      "message" : "Alarm details"
    },
    "attach_rule" : { }
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

200

OK The request is successful.

204

OK The request is successful.

400

Bad Request Invalid request. 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.

Parent topic: Alarm