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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
action |
No |
String |
Requested action.
Enumeration values:
|
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
starts_at |
No |
Long |
Time when an event or alarm is generated (CST timestamp precise down to the millisecond). Example: 2024-10-16 16:03:01 needs to be converted to CST timestamp 1729065781000 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 (CST 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 CST timestamp 1729065781000 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. Unit: ms. For example, if an alarm is cleared after 1 minute, set this parameter to 60000 By default, alarms older than five days will be cleared. The corresponding value is 7,200 × 60,000 (5 days × 24 hours × 60 minutes × 60,000 ms). Max.: 15 days.This parameter needs to be specified if the value of action is left blank (which indicates that an alarm is to be reported). |
metadata |
No |
Map<String,String> |
Details about an event or alarm to be reported. The value is a key-value pair. Mandatory fields:
|
annotations |
No |
Map<String,Object> |
Additional field for an event or alarm, which can be left blank. |
attach_rule |
No |
Map<String,Object> |
Reserved field for an event or alarm, which can be left blank. |
id |
No |
String |
Event or alarm ID, which is automatically generated when an event or alarm is generated. This parameter needs to be specified if the value of action is set to clear. |
Response Parameters
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" }
SDK Sample Code
The SDK sample code is as follows.
Java
Report an alarm named "test".
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.aom.v2.region.AomRegion; import com.huaweicloud.sdk.aom.v2.*; import com.huaweicloud.sdk.aom.v2.model.*; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.util.HashMap; public class PushEventsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); PushEventsRequest request = new PushEventsRequest(); EventList body = new EventList(); Map<String, Object> listEventsAnnotations = new HashMap<>(); listEventsAnnotations.put("alarm_probableCause_zh_cn", "Possible Causes"); listEventsAnnotations.put("alarm_fix_suggestion_zh_cn", "Suggestions"); listEventsAnnotations.put("message", "Alarm Details"); Map<String, String> listEventsMetadata = new HashMap<>(); listEventsMetadata.put("event_name", "test"); listEventsMetadata.put("event_severity", "Major"); listEventsMetadata.put("event_type", "alarm"); listEventsMetadata.put("resource_provider", "ecs"); listEventsMetadata.put("resource_type", "vm"); listEventsMetadata.put("resource_id", "ecs123"); List<EventModel> listbodyEvents = new ArrayList<>(); listbodyEvents.add( new EventModel() .withStartsAt(1605232501000L) .withTimeout(60000L) .withMetadata(listEventsMetadata) .withAnnotations(listEventsAnnotations) .withAttachRule() ); body.withEvents(listbodyEvents); request.withBody(body); try { PushEventsResponse response = client.pushEvents(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
Report an alarm named "test".
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v2.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = PushEventsRequest() listAnnotationsEvents = { "alarm_probableCause_zh_cn": "Possible Causes", "alarm_fix_suggestion_zh_cn": "Suggestions", "message": "Alarm Details" } listMetadataEvents = { "event_name": "test", "event_severity": "Major", "event_type": "alarm", "resource_provider": "ecs", "resource_type": "vm", "resource_id": "ecs123" } listEventsbody = [ EventModel( starts_at=1605232501000, timeout=60000, metadata=listMetadataEvents, annotations=listAnnotationsEvents, ) ] request.body = EventList( events=listEventsbody ) response = client.push_events(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
Report an alarm named "test".
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.PushEventsRequest{} var listAnnotationsEvents = map[string]interface{}{ "alarm_probableCause_zh_cn": "Possible Causes", "alarm_fix_suggestion_zh_cn": "Suggestions", "message": "Alarm Details", } var listMetadataEvents = map[string]string{ "event_name": "test", "event_severity": "Major", "event_type": "alarm", "resource_provider": "ecs", "resource_type": "vm", "resource_id": "ecs123", } startsAtEvents:= int64(1605232501000) timeoutEvents:= int64(60000) var listEventsbody = []model.EventModel{ { StartsAt: &startsAtEvents, Timeout: &timeoutEvents, Metadata: listMetadataEvents, Annotations: listAnnotationsEvents, }, } request.Body = &model.EventList{ Events: listEventsbody, } response, err := client.PushEvents(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
204 |
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.
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