Help Center/ Log Tank Service/ API Reference/ APIs/ Alarm List/ Querying the Active or Historical Alarm List
Updated on 2024-06-13 GMT+08:00

Querying the Active or Historical Alarm List

Function

This API is used to query the alarm list.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/{domain_id}/lts/alarms/sql-alarm/query

Table 1 Path Parameters

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

domain_id

Yes

String

Account ID. For details about how to obtain an account ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.

Default: None

Minimum: 32

Maximum: 32

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Whether the alarm is an active alarm or a historical alarm.

Enumeration values:

  • active_alert

  • history_alert

marker

No

String

The value is the ID of the last record on the previous page (value of previous_marker or next_marker returned by the previous page).

Minimum: 0

Maximum: 1000

limit

No

Integer

Number of records on each page.

Minimum: 0

Maximum: 1000

Request Parameters

Table 3 Request header 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

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

whether_custom_field

Yes

Boolean

Whether to customize the query time segment.

start_time

No

Long

Start time of a customized time segment (timestamp).

Minimum: 13

Maximum: 13

end_time

No

Long

End time of a customized time segment (timestamp).

Minimum: 13

Maximum: 13

time_range

No

String

Non-customized time range (in minutes).

Minimum: 1

Maximum: 32

search

No

String

Keyword search criteria.

Minimum: 1

Maximum: 1024

alarm_level_ids

No

Array of strings

Alarm severity (Critical, Major, Minor, Info).

NOTE:

alarmLevelIds is a parameter of an earlier version and is currently compatible with this parameter. You are advised to use this parameter. alarm_level_ids

sort

No

Sort object

Sort search criteria.

step

No

Integer

Keyword search criteria.

Table 5 Sort

Parameter

Mandatory

Type

Description

order_by

Yes

Array of strings

Sorting field.

order

Yes

String

Sorting order.

Enumeration values:

  • desc

  • asc

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

events

Array of Events objects

Alarm information.

Minimum length: 0 characters Maximum length: 2048 characters

page_info

PageInfo object

Pagination details.

Minimum length: 0 characters Maximum length: 2048 characters

Table 7 Events

Parameter

Type

Description

annotations

Annotations object

Alarm details. The length ranges from 0 to 5000 characters.

metadata

Metadata object

Alarms Minimum length: 0 characters Maximum length: 2048 characters

arrives_at

Long

Arrival time (timestamp).

Minimum: 13

Maximum: 13

ends_at

Long

Alarm clearance time (timestamp).

Minimum: 13

Maximum: 13

id

String

Alarm ID.

Minimum: 0

Maximum: 64

starts_at

Long

Alarm generation time (timestamp).

Minimum: 13

Maximum: 13

timeout

Long

Time when an alarm is automatically cleared (timestamp).

Minimum: 1

Maximum: 13

type

String

Alarm rule type (SQL/keyword).

Minimum: 0

Maximum: 16

Table 8 Annotations

Parameter

Type

Description

message

String

Alarm list details.

Minimum: 1

Maximum: 1024

log_info

String

Log group/stream ID.

Minimum: 1

Maximum: 1024

current_value

String

Current value.

Minimum: 1

Maximum: 1024

old_annotations

String

Original data of (SQL/keyword) alarm details.

Minimum: 0

Maximum: 10000

Table 9 Metadata

Parameter

Type

Description

event_type

String

Alarm type.

Minimum: 1

Maximum: 1024

event_id

String

Alarm ID.

Minimum: 1

Maximum: 1024

event_severity

String

Alarm severity.

Minimum: 1

Maximum: 1024

event_name

String

Alarm name.

Minimum: 1

Maximum: 1024

resource_type

String

Resource type.

Minimum: 1

Maximum: 1024

resource_id

String

Log group/stream name.

Minimum: 1

Maximum: 1024

resource_provider

String

Alarm source.

Minimum: 1

Maximum: 1024

lts_alarm_type

String

Alarm rule type (SQL/keyword).

Minimum: 1

Maximum: 100

Table 10 PageInfo

Parameter

Type

Description

next_marker

String

Address of the next page. If this parameter is left empty, no data is displayed on the next page.

Minimum: 0

Maximum: 5000

previous_marker

String

Address of the previous page.

Minimum: 0

Maximum: 5000

current_count

String

Number of items returned on this page.

Minimum: 0

Maximum: 1000

Example Requests

Querying the active or historical alarm list

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"
  }
}

Example Responses

Status code: 200

The request is successful.

{
  "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 Sample Code

The SDK sample code is as follows.

Querying the active or historical alarm list

 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
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.withType(ListActiveOrHistoryAlarmsRequest.TypeEnum.fromValue("<type>"));
        request.withMarker("<marker>");
        request.withLimit(<limit>);
        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());
        }
    }
}

Querying the active or historical alarm list

 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 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.type = "<type>"
        request.marker = "<marker>"
        request.limit = <limit>
        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)

Querying the active or historical alarm list

 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
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.Type = model.GetListActiveOrHistoryAlarmsRequestTypeEnum().<TYPE>
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	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)
    }
}

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.

Error Codes

See Error Codes.