Querying the Event Alarm Rule List
Function
This API is used to query the event alarm rule list.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/event2alarm-rule
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID obtained from IAM. Generally, a project ID contains 32 characters. Minimum: 32 Maximum: 32 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. Minimum: 0 Maximum: 40960 |
Content-Type |
Yes |
String |
Content type, which is application/json. Enumeration values:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
[items] |
Array of Event2alarmRuleBody objects |
OK: The request is successful. |
Parameter |
Type |
Description |
---|---|---|
user_id |
String |
Project ID. Minimum: 32 Maximum: 32 |
name |
String |
Rule name. Enter a maximum of 100 characters and do not start or end with a special character. Only letters, digits, underscores (_), and hyphens (-) are allowed. Minimum: 1 Maximum: 100 |
description |
String |
Rule description. Enter a maximum of 1024 characters and do not start or end with an underscore (_) or hyphen (-). Only letters, digits, and special characters (_-<>=,.) are allowed. Minimum: 0 Maximum: 1024 |
create_time |
Long |
Creation time. Minimum: 0 Maximum: 9999999999999 |
update_time |
Long |
Update time. Minimum: 0 Maximum: 9999999999999 |
resource_provider |
String |
Event source. Minimum: 0 Maximum: 64 |
metadata |
metadata object |
Source data. |
enable |
Boolean |
Whether to enable the rule. |
trigger_policies |
Array of trigger_policies objects |
Trigger policy. Array Length: 0 - 1024 |
alarm_type |
String |
Alarm type. notification: direct alarm reporting. denoising: alarm noise reduction. Minimum: 0 Maximum: 32 Enumeration values:
|
action_rule |
String |
Alarm action rule. Minimum: 0 Maximum: 128 |
inhibit_rule |
String |
Alarm suppression rule. Minimum: 0 Maximum: 128 |
route_group_rule |
String |
Alarm grouping rule. Minimum: 0 Maximum: 128 |
event_names |
Array of strings |
Event name. |
migrated |
Boolean |
Whether to migrate to AOM 2.0. |
topics |
Array of SmnTopics objects |
SMN information. |
Parameter |
Type |
Description |
---|---|---|
customField |
Array of strings |
Custom tag. Minimum: 0 Maximum: 1024 Array Length: 0 - 1024 |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
ID. Minimum: 0 Maximum: 128 |
name |
String |
Event name. Minimum: 0 Maximum: 128 |
trigger_type |
String |
Trigger type. accumulative: Accumulated trigger. immediately: Immediate trigger. Minimum: 0 Maximum: 128 Enumeration values:
|
period |
Integer |
Trigger cycle. Minimum: 1 Maximum: 86400 |
operator |
String |
Comparison operator. Minimum: 0 Maximum: 8 |
count |
Integer |
Number of trigger times. Minimum: 1 Maximum: 100 |
level |
String |
Alarm severity. Minimum: 0 Maximum: 32 |
Parameter |
Type |
Description |
---|---|---|
display_name |
String |
Topic display name, which will be the name of an email sender. Max.: 192 bytes. This parameter is left blank by default. Minimum: 1 Maximum: 64 |
name |
String |
Name of the topic. Enter 1 to 255 characters starting with a letter or digit. Only letters, digits, hyphens (-), and underscores (_) are allowed. Minimum: 1 Maximum: 255 |
push_policy |
Integer |
SMN message push policy. Options: 0 and 1. Minimum: 0 Maximum: 1 |
status |
Integer |
Status of the topic subscriber. 0: The topic has been deleted or the subscription list of this topic is empty. 1: The subscription object is in the subscribed state. 2: The subscription object is in the unsubscribed or canceled state. Enumeration values:
|
topic_urn |
String |
Unique resource identifier of the topic. Minimum: 1 Maximum: 100 |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 12 Maximum: 12 |
error_msg |
String |
Error message. Minimum: 0 Maximum: 1024 |
error_type |
String |
Error type. Minimum: 0 Maximum: 128 |
trace_id |
String |
Request ID. Minimum: 32 Maximum: 32 |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 12 Maximum: 12 |
error_msg |
String |
Error message. Minimum: 0 Maximum: 1024 |
error_type |
String |
Error type. Minimum: 0 Maximum: 128 |
trace_id |
String |
Request ID. Minimum: 32 Maximum: 32 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 12 Maximum: 12 |
error_msg |
String |
Error message. Minimum: 0 Maximum: 1024 |
error_type |
String |
Error type. Minimum: 0 Maximum: 128 |
trace_id |
String |
Request ID. Minimum: 32 Maximum: 32 |
Example Requests
Query the event alarm rule list.
https://{endpoint}/v2/{project_id}/event2alarm-rule
Example Responses
Status code: 200
OK: The request is successful.
[ { "action_rule" : "1", "alarm_type" : "notification", "create_time" : 1701442632968, "description" : "", "enable" : true, "event_names" : [ ], "inhibit_rule" : "", "metadata" : { "customField" : [ "xxx" ] }, "migrated" : false, "name" : "1jB5h6GnbY", "resource_provider" : "AOM", "route_group_rule" : "", "topics" : [ ], "trigger_policies" : [ { "count" : 99, "id" : 0, "level" : "", "name" : "", "operator" : ">=", "period" : 300, "trigger_type" : "accumulative" } ], "update_time" : 0, "user_id" : "2a473356cca5487f8373be891bffc1cf" } ]
Status code: 401
Unauthorized: The authentication information is incorrect or invalid.
{ "error_code" : "SVCSTG.AMS.2000051", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED" }
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_msg" : "auth failed.", "error_type" : "AUTH_FAILED" }
Status code: 500
Internal Server Error: The server is able to receive the request but unable to understand the request.
{ "error_code" : "APM.00000500", "error_msg" : "Internal Server Error", "trace_id" : "" }
SDK Sample Code
The SDK sample code is as follows.
Java
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 |
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.*; public class ListEvent2alarmRuleSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); ListEvent2alarmRuleRequest request = new ListEvent2alarmRuleRequest(); try { ListEvent2alarmRuleResponse response = client.listEvent2alarmRule(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
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 |
# 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"] credentials = BasicCredentials(ak, sk) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListEvent2alarmRuleRequest() response = client.list_event2alarm_rule(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
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListEvent2alarmRuleRequest{} response, err := client.ListEvent2alarmRule(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 |
---|---|
200 |
OK: The request is successful. |
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. |
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