查询活动或历史告警列表
功能介绍
该接口用于查询告警列表
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/{domain_id}/lts/alarms/sql-alarm/query
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:32 最大长度:32 |
domain_id |
是 |
String |
账号ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:32 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
是活动告警还是历史告警。 |
marker |
否 |
String |
取值为上一页数据的最后一条记录的id(填写上一页数据返回的previous_marker或者next_marker值)。 最小长度:0 最大长度:1000 |
limit |
否 |
Integer |
每页数据量 最小值:0 最大值:1000 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1000 最大长度:2000 |
Content-Type |
是 |
String |
该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
whether_custom_field |
是 |
Boolean |
是否自定义查询时间段 |
start_time |
否 |
Long |
自定义时间段开始时间(时间戳) 最小值:13 最大值:13 |
end_time |
否 |
Long |
自定义时间段结束时间(时间戳) 最小值:13 最大值:13 |
time_range |
否 |
String |
非自定义时间段时间范围(单位为分钟) 最小长度:1 最大长度:32 |
search |
否 |
String |
关键字检索条件 最小长度:1 最大长度:1024 |
alarm_level_ids |
否 |
Array of strings |
告警级别("Critical","Major","Minor","Info")
说明:
alarmLevelIds为旧版参数,目前兼容该参数,建议使用 alarm_level_ids |
sort |
否 |
Sort object |
排序检索条件 |
step |
否 |
Integer |
关键字检索条件 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
events |
Array of Events objects |
告警信息 最小长度:0 最大长度:2048 |
page_info |
PageInfo object |
分页详情 最小长度:0 最大长度:2048 |
参数 |
参数类型 |
描述 |
---|---|---|
annotations |
Annotations object |
告警详情 最小长度:0最大长度:5000 |
metadata |
Metadata object |
告警信息 最小长度:0 最大长度:2048 |
arrives_at |
Long |
到达时间(时间戳) 最小值:13 最大值:13 |
ends_at |
Long |
告警清除时间(时间戳) 最小值:13 最大值:13 |
id |
String |
告警id 最小长度:0 最大长度:64 |
starts_at |
Long |
告警产生时间(时间戳) 最小值:13 最大值:13 |
timeout |
Long |
告警自动清除时间(时间戳) 最小值:1 最大值:13 |
type |
String |
告警规则类型(SQL/关键词) 最小长度:0 最大长度:16 |
参数 |
参数类型 |
描述 |
---|---|---|
message |
String |
告警列表详情 最小长度:1 最大长度:1024 |
log_info |
String |
日志组/流id名称 最小长度:1 最大长度:1024 |
current_value |
String |
当前值 最小长度:1 最大长度:1024 |
old_annotations |
String |
(sql/关键词)告警详情原始数据 最小长度:0 最大长度:10000 |
参数 |
参数类型 |
描述 |
---|---|---|
event_type |
String |
告警类型 最小长度:1 最大长度:1024 |
event_id |
String |
告警id 最小长度:1 最大长度:1024 |
event_severity |
String |
告警级别 最小长度:1 最大长度:1024 |
event_name |
String |
告警名称 最小长度:1 最大长度:1024 |
resource_type |
String |
资源类型 最小长度:1 最大长度:1024 |
resource_id |
String |
日志组/流名称 最小长度:1 最大长度:1024 |
resource_provider |
String |
告警源 最小长度:1 最大长度:1024 |
lts_alarm_type |
String |
告警规则类型(SQL/关键词) 最小长度:1 最大长度:100 |
log_group_name |
String |
日志组原始名称 |
log_stream_name |
String |
日志流原始名称 |
请求示例
查询活动或历史告警列表
POST https://{endpoint}/v2/{project_id}/{domain_id}/lts/alarms/sql-alarm/query { "whether_custom_field" : false, "start_time" : 0, "end_time" : 0, "time_range" : "30", "search" : "", "alarm_level_ids" : [ "Critical", "Major", "Minor", "Info" ], "sort" : { "order_by" : [ "starts_at" ], "order" : "desc" } }
响应示例
状态码: 200
请求响应成功。
{ "events" : [ { "annotations" : { "message" : "string", "log_info" : "string", "current_value" : "string" }, "metadata" : { "event_type" : "string", "event_id" : "string", "event_severity" : "string", "event_name" : "string", "resource_type" : "string", "resource_id" : "string", "resource_provider" : "string", "lts_alarm_type" : "string" }, "id" : "string", "type" : "string" } ], "page_info" : { "next_marker" : "string", "previous_marker" : "string", "current_count" : 0 } }
SDK代码示例
SDK代码示例如下。
查询活动或历史告警列表
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 |
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 ListActiveOrHistoryAlarmsSolution { 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(); ListActiveOrHistoryAlarmsRequest request = new ListActiveOrHistoryAlarmsRequest(); request.withDomainId("{domain_id}"); ListActiveOrHistoryAlarmsRequestBody body = new ListActiveOrHistoryAlarmsRequestBody(); List<String> listSortOrderBy = new ArrayList<>(); listSortOrderBy.add("starts_at"); Sort sortbody = new Sort(); sortbody.withOrderBy(listSortOrderBy) .withOrder(Sort.OrderEnum.fromValue("desc")); List<String> listbodyAlarmLevelIds = new ArrayList<>(); listbodyAlarmLevelIds.add("Critical"); listbodyAlarmLevelIds.add("Major"); listbodyAlarmLevelIds.add("Minor"); listbodyAlarmLevelIds.add("Info"); body.withSort(sortbody); body.withAlarmLevelIds(listbodyAlarmLevelIds); body.withSearch(""); body.withTimeRange("30"); body.withEndTime(0L); body.withStartTime(0L); body.withWhetherCustomField(false); request.withBody(body); try { ListActiveOrHistoryAlarmsResponse response = client.listActiveOrHistoryAlarms(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()); } } } |
查询活动或历史告警列表
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 |
# 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 = ListActiveOrHistoryAlarmsRequest() request.domain_id = "{domain_id}" listOrderBySort = [ "starts_at" ] sortbody = Sort( order_by=listOrderBySort, order="desc" ) listAlarmLevelIdsbody = [ "Critical", "Major", "Minor", "Info" ] request.body = ListActiveOrHistoryAlarmsRequestBody( sort=sortbody, alarm_level_ids=listAlarmLevelIdsbody, search="", time_range="30", end_time=0, start_time=0, whether_custom_field=False ) response = client.list_active_or_history_alarms(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
查询活动或历史告警列表
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 |
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.ListActiveOrHistoryAlarmsRequest{} request.DomainId = "{domain_id}" var listOrderBySort = []string{ "starts_at", } sortbody := &model.Sort{ OrderBy: listOrderBySort, Order: model.GetSortOrderEnum().DESC, } var listAlarmLevelIdsbody = []string{ "Critical", "Major", "Minor", "Info", } searchListActiveOrHistoryAlarmsRequestBody:= "" timeRangeListActiveOrHistoryAlarmsRequestBody:= "30" endTimeListActiveOrHistoryAlarmsRequestBody:= int64(0) startTimeListActiveOrHistoryAlarmsRequestBody:= int64(0) request.Body = &model.ListActiveOrHistoryAlarmsRequestBody{ Sort: sortbody, AlarmLevelIds: &listAlarmLevelIdsbody, Search: &searchListActiveOrHistoryAlarmsRequestBody, TimeRange: &timeRangeListActiveOrHistoryAlarmsRequestBody, EndTime: &endTimeListActiveOrHistoryAlarmsRequestBody, StartTime: &startTimeListActiveOrHistoryAlarmsRequestBody, WhetherCustomField: false, } response, err := client.ListActiveOrHistoryAlarms(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求响应成功。 |
错误码
请参见错误码。