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.
URI
PUT /v2/{project_id}/push/events
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. |
Request 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. Content type, which is application/json. Enumeration values: |
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). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
events |
Yes |
Array of EventModel objects |
Event or alarm details. |
Response Parameters
Status code: 204
No Content: The request is successful, but no content is returned.
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
error_type |
String |
API call failure 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" }, "attach_rule" : { } } ] }
Example Responses
Status code: 400
Bad Request: The request is invalid. The client should not repeat the request without modifications.
{ "error_code" : "AOM.0400", "error_msg" : "parse eventParam failed", "error_type" : "SC_BAD_REQUEST" }
Status Codes
Status Code |
Description |
---|---|
204 |
No Content: The request is successful, but no content is returned. |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot