Creating a Keyword Alarm Rule
Function
This API is used to create a keyword alarm. Currently, each account can create a maximum of 200 keyword alarms and SQL alarms.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/lts/alarms/keywords-alarm-rule
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. Default: None Minimum: 32 Maximum: 32 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token. Default: None Minimum: 1000 Maximum: 2000 |
Content-Type |
Yes |
String |
Set this parameter to application/json;charset=UTF-8. Default: None Minimum: 30 Maximum: 30 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
keywords_alarm_rule_name |
Yes |
String |
Keyword alarm names. NOTE:
Cannot start with a period (.) or underscore (_) or end with a period (.). Minimum: 1 Maximum: 64 |
keywords_alarm_rule_description |
No |
String |
Keyword alarm description. Minimum: 0 Maximum: 64 |
keywords_requests |
Yes |
Array of KeywordsRequest objects |
Keyword details. |
frequency |
Yes |
Frequency object |
Alarm statistical period. |
keywords_alarm_level |
Yes |
String |
Alarm severity. Enumeration values:
|
keywords_alarm_send |
Yes |
Boolean |
Whether to send an alarm. |
domain_id |
Yes |
String |
domainId Minimum: 32 Maximum: 32 |
notification_save_rule |
No |
SqlNotificationSaveRule object |
Topic |
trigger_condition_count |
No |
Integer |
Trigger condition. The number of triggering times is 1 by default. |
trigger_condition_frequency |
No |
Integer |
Trigger condition. The number of triggering periods is 1 by default. |
whether_recovery_policy |
No |
Boolean |
Indicates whether to enable the recovery notification. The default value is false. |
recovery_policy |
No |
Integer |
The recovery policy period is 3 by default. |
notification_frequency |
Yes |
Integer |
Notification frequency, in minutes. Enumeration values:
|
alarm_action_rule_name |
No |
String |
Alarm action rule name. NOTE:
Set alarm_action_rule_name or notification_save_rule. If you set both of them, the value of alarm_action_rule_name is prioritized. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
log_stream_id |
Yes |
String |
Log stream ID. Minimum: 36 Maximum: 36 |
log_stream_name |
No |
String |
Log stream name. Minimum: 1 Maximum: 64 |
log_group_id |
Yes |
String |
Log group ID. Minimum: 36 Maximum: 36 |
log_group_name |
No |
String |
Log group name. Minimum: 1 Maximum: 64 |
keywords |
Yes |
String |
Keyword Minimum: 1 Maximum: 1024 |
condition |
Yes |
String |
Condition Enumeration values:
|
number |
Yes |
Integer |
Row Minimum: 1 Maximum: 2147483647 |
search_time_range |
Yes |
Integer |
Time range for querying the latest data when a task is executed. The maximum value is 60 and the minimum is 1 if the unit is minute. The maximum is 24 and the minimum is 1 if the unit is hour. |
search_time_range_unit |
Yes |
String |
Query time unit. Enumeration values:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
Yes |
String |
Time type. Enumeration values:
|
cron_expr |
No |
String |
This field is used when type is set to CRON. Minimum: 1 Maximum: 1024 |
hour_of_day |
No |
Integer |
This field is used when type is set to DAILY or WEEKLY. DAILY ranges from 0 to 23. WEEKLY ranges from 0 to 23. |
day_of_week |
No |
Integer |
This field is used when type is set to WEEKLY (Sunday to Saturday). Minimum: 1 Maximum: 7 |
fixed_rate |
No |
Integer |
This field is used when type is set to FIXED_RATE. If the unit of fixed_rate_unit is minute, the maximum value is 60. If the unit is hour, the value ranges from 5 to 24. Minimum: 1 Maximum: 60 |
fixed_rate_unit |
No |
String |
Time unit. Enumeration values:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
language |
Yes |
String |
Language of the preference. Minimum: 0 Maximum: 10 Enumeration values:
|
timezone |
No |
String |
Time zone of the preference. Minimum: 0 Maximum: 1024 |
user_name |
Yes |
String |
Username. Minimum: 1 Maximum: 1024 |
topics |
Yes |
Array of Topics objects |
Topic information. |
template_name |
Yes |
String |
Message template name. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Topic name. Minimum: 1 Maximum: 1024 |
topic_urn |
Yes |
String |
Specifies the resource identifier of the topic, which is unique. Minimum: 1 Maximum: 1024 |
display_name |
No |
String |
Specifies the topic display name, which is presented as the name of the email sender in email messages. Minimum: 1 Maximum: 1024 |
push_policy |
No |
Integer |
Specifies the message push policy. Minimum: 1 Maximum: 1024 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
keywords_alarm_rule_id |
String |
Alarm rule ID. Minimum: 36 Maximum: 36 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. Enumeration values:
|
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. Enumeration values:
|
Example Requests
Creating a keyword alarm rule
POST https://{endpoint}/v2/{project_id}/lts/alarms/keywords-alarm-rule { "keywords_alarm_rule_name" : "huawei", "keywords_alarm_rule_description" : "huawei", "keywords_requests" : [ { "log_stream_id" : "1", "log_group_id" : "1", "keywords" : "huawei", "condition" : ">", "number" : "100", "search_time_range" : 10, "search_time_range_unit" : "minute" } ], "frequency" : { "type" : "FIXED_RATE", "cron_expr" : "", "hour_of_day" : 0, "day_of_week" : 0, "fixed_rate" : 10, "fixed_rate_unit" : "minute" }, "keywords_alarm_level" : "Critical", "keywords_alarm_send" : true, "domain_id" : "", "notification_frequency" : 5, "alarm_action_rule_name" : "", "notification_save_rule" : { "language" : "en-us", "timezone" : "Asia/Shanghai", "user_name" : "huawei", "template_name" : "Message template name", "topics" : [ { "name" : "huawei", "topic_urn" : "urn:smn:cn-north-7:1b06fc5dc0814a4da1594a9ade9cb93c:huawei", "display_name" : "", "push_policy" : 0 } ] } }
Example Responses
Status code: 200
The request is successful.
{ "keywords_alarm_rule_id" : "" }
Status code: 400
Invalid request. Modify the request based on the description in error_msg before a retry.
{ "error_code" : "LTS.2005", "error_msg" : "Alarm rule params validator error." }
Status code: 500
The server has received the request but encountered an internal error.
{ "error_code" : "LTS.2001", "error_msg" : "Failed to create alarm rule." }
SDK Sample Code
The SDK sample code is as follows.
Creating a keyword alarm rule
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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
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.lts.v2.region.LtsRegion; import com.huaweicloud.sdk.lts.v2.*; import com.huaweicloud.sdk.lts.v2.model.*; import java.util.List; import java.util.ArrayList; public class CreateKeywordsAlarmRuleSolution { 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); LtsClient client = LtsClient.newBuilder() .withCredential(auth) .withRegion(LtsRegion.valueOf("<YOUR REGION>")) .build(); CreateKeywordsAlarmRuleRequest request = new CreateKeywordsAlarmRuleRequest(); CreateKeywordsAlarmRuleRequestBody body = new CreateKeywordsAlarmRuleRequestBody(); List<Topics> listNotificationSaveRuleTopics = new ArrayList<>(); listNotificationSaveRuleTopics.add( new Topics() .withName("huawei") .withTopicUrn("urn:smn:cn-north-7:1b06fc5dc0814a4da1594a9ade9cb93c:huawei") .withDisplayName("") .withPushPolicy(0) ); SqlNotificationSaveRule notificationSaveRulebody = new SqlNotificationSaveRule(); notificationSaveRulebody.withLanguage(SqlNotificationSaveRule.LanguageEnum.fromValue("en-us")) .withTimezone("Asia/Shanghai") .withUserName("huawei") .withTopics(listNotificationSaveRuleTopics) .withTemplateName("Message template name"); Frequency frequencybody = new Frequency(); frequencybody.withType(Frequency.TypeEnum.fromValue("FIXED_RATE")) .withCronExpr("") .withHourOfDay(0) .withDayOfWeek(0) .withFixedRate(10) .withFixedRateUnit(Frequency.FixedRateUnitEnum.fromValue("minute")); List<KeywordsRequest> listbodyKeywordsRequests = new ArrayList<>(); listbodyKeywordsRequests.add( new KeywordsRequest() .withLogStreamId("1") .withLogGroupId("1") .withKeywords("huawei") .withCondition(KeywordsRequest.ConditionEnum.fromValue(">")) .withNumber(100) .withSearchTimeRange(10) .withSearchTimeRangeUnit(KeywordsRequest.SearchTimeRangeUnitEnum.fromValue("minute")) ); body.withAlarmActionRuleName(""); body.withNotificationFrequency(CreateKeywordsAlarmRuleRequestBody.NotificationFrequencyEnum.NUMBER_5); body.withNotificationSaveRule(notificationSaveRulebody); body.withDomainId(""); body.withKeywordsAlarmSend(true); body.withKeywordsAlarmLevel(CreateKeywordsAlarmRuleRequestBody.KeywordsAlarmLevelEnum.fromValue("Critical")); body.withFrequency(frequencybody); body.withKeywordsRequests(listbodyKeywordsRequests); body.withKeywordsAlarmRuleDescription("huawei"); body.withKeywordsAlarmRuleName("huawei"); request.withBody(body); try { CreateKeywordsAlarmRuleResponse response = client.createKeywordsAlarmRule(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()); } } } |
Creating a keyword alarm rule
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 75 76 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklts.v2.region.lts_region import LtsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklts.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 = LtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(LtsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateKeywordsAlarmRuleRequest() listTopicsNotificationSaveRule = [ Topics( name="huawei", topic_urn="urn:smn:cn-north-7:1b06fc5dc0814a4da1594a9ade9cb93c:huawei", display_name="", push_policy=0 ) ] notificationSaveRulebody = SqlNotificationSaveRule( language="en-us", timezone="Asia/Shanghai", user_name="huawei", topics=listTopicsNotificationSaveRule, template_name="Message template name" ) frequencybody = Frequency( type="FIXED_RATE", cron_expr="", hour_of_day=0, day_of_week=0, fixed_rate=10, fixed_rate_unit="minute" ) listKeywordsRequestsbody = [ KeywordsRequest( log_stream_id="1", log_group_id="1", keywords="huawei", condition=">", number=100, search_time_range=10, search_time_range_unit="minute" ) ] request.body = CreateKeywordsAlarmRuleRequestBody( alarm_action_rule_name="", notification_frequency=5, notification_save_rule=notificationSaveRulebody, domain_id="", keywords_alarm_send=True, keywords_alarm_level="Critical", frequency=frequencybody, keywords_requests=listKeywordsRequestsbody, keywords_alarm_rule_description="huawei", keywords_alarm_rule_name="huawei" ) response = client.create_keywords_alarm_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) |
Creating a keyword alarm rule
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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/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 := lts.NewLtsClient( lts.LtsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateKeywordsAlarmRuleRequest{} displayNameTopics:= "" pushPolicyTopics:= int32(0) var listTopicsNotificationSaveRule = []model.Topics{ { Name: "huawei", TopicUrn: "urn:smn:cn-north-7:1b06fc5dc0814a4da1594a9ade9cb93c:huawei", DisplayName: &displayNameTopics, PushPolicy: &pushPolicyTopics, }, } timezoneNotificationSaveRule:= "Asia/Shanghai" notificationSaveRulebody := &model.SqlNotificationSaveRule{ Language: model.GetSqlNotificationSaveRuleLanguageEnum().EN_US, Timezone: &timezoneNotificationSaveRule, UserName: "huawei", Topics: listTopicsNotificationSaveRule, TemplateName: "Message template name", } cronExprFrequency:= "" hourOfDayFrequency:= int32(0) dayOfWeekFrequency:= int32(0) fixedRateFrequency:= int32(10) fixedRateUnitFrequency:= model.GetFrequencyFixedRateUnitEnum().MINUTE frequencybody := &model.Frequency{ Type: model.GetFrequencyTypeEnum().FIXED_RATE, CronExpr: &cronExprFrequency, HourOfDay: &hourOfDayFrequency, DayOfWeek: &dayOfWeekFrequency, FixedRate: &fixedRateFrequency, FixedRateUnit: &fixedRateUnitFrequency, } var listKeywordsRequestsbody = []model.KeywordsRequest{ { LogStreamId: "1", LogGroupId: "1", Keywords: "huawei", Condition: model.GetKeywordsRequestConditionEnum().GREATER_THAN, Number: int32(100), SearchTimeRange: int32(10), SearchTimeRangeUnit: model.GetKeywordsRequestSearchTimeRangeUnitEnum().MINUTE, }, } alarmActionRuleNameCreateKeywordsAlarmRuleRequestBody:= "" keywordsAlarmRuleDescriptionCreateKeywordsAlarmRuleRequestBody:= "huawei" request.Body = &model.CreateKeywordsAlarmRuleRequestBody{ AlarmActionRuleName: &alarmActionRuleNameCreateKeywordsAlarmRuleRequestBody, NotificationFrequency: model.GetCreateKeywordsAlarmRuleRequestBodyNotificationFrequencyEnum().E_5, NotificationSaveRule: notificationSaveRulebody, DomainId: "", KeywordsAlarmSend: true, KeywordsAlarmLevel: model.GetCreateKeywordsAlarmRuleRequestBodyKeywordsAlarmLevelEnum().CRITICAL, Frequency: frequencybody, KeywordsRequests: listKeywordsRequestsbody, KeywordsAlarmRuleDescription: &keywordsAlarmRuleDescriptionCreateKeywordsAlarmRuleRequestBody, KeywordsAlarmRuleName: "huawei", } response, err := client.CreateKeywordsAlarmRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
The request is successful. |
400 |
Invalid request. Modify the request based on the description in error_msg before a retry. |
500 |
The server has received the request but encountered an internal error. |
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