更新时间:2024-12-20 GMT+08:00
分享

删除活动告警

功能介绍

该接口用于删除活动告警

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID

最小长度:32

最大长度:32

domain_id

String

账号ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token,获取方式请参见:获取用户Token

最小长度:1000

最大长度:2000

Content-Type

String

该字段填为:application/json;charset=UTF-8。

最小长度:30

最大长度:30

表3 请求Body参数

参数

是否必选

参数类型

描述

events

Array of Event objects

主题信息

表4 Event

参数

是否必选

参数类型

描述

metadata

Metadata object

告警信息

最小长度:0

最大长度:2048

starts_at

Long

告警产生时间(时间戳)

最小值:0

最大值:32

表5 Metadata

参数

是否必选

参数类型

描述

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

日志流原始名称

响应参数

请求示例

根据告警ID删除活动告警

POST https://{endpoint}/v2/{project_id}/{domain_id}/lts/alarms/sql-alarm/clear

{
  "events" : [ {
    "metadata" : {
      "event_type" : "alarm",
      "event_id" : "1",
      "lts_alarm_type" : "keywords/sql",
      "resource_type" : "日志组/流",
      "event_severity" : "Critical",
      "resource_id" : "lts-group-demo/lts-topic-demo",
      "event_name" : "demo",
      "resource_provider" : "LTS",
      "log_group_name" : "lts-group-demo",
      "log_stream_name" : "lts-topic-demo"
    },
    "starts_at" : 1629947408497
  } ]
}

响应示例

SDK代码示例

SDK代码示例如下。

根据告警ID删除活动告警

 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
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 DeleteActiveAlarmsSolution {

    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();
        DeleteActiveAlarmsRequest request = new DeleteActiveAlarmsRequest();
        request.withDomainId("{domain_id}");
        DeleteActiveAlarmsRequestBody body = new DeleteActiveAlarmsRequestBody();
        Metadata metadataEvents = new Metadata();
        metadataEvents.withEventType("alarm")
            .withEventId("1")
            .withEventSeverity("Critical")
            .withEventName("demo")
            .withResourceType("日志组/流")
            .withResourceId("lts-group-demo/lts-topic-demo")
            .withResourceProvider("LTS")
            .withLtsAlarmType("keywords/sql")
            .withLogGroupName("lts-group-demo")
            .withLogStreamName("lts-topic-demo");
        List<Event> listbodyEvents = new ArrayList<>();
        listbodyEvents.add(
            new Event()
                .withMetadata(metadataEvents)
                .withStartsAt(1629947408497L)
        );
        body.withEvents(listbodyEvents);
        request.withBody(body);
        try {
            DeleteActiveAlarmsResponse response = client.deleteActiveAlarms(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());
        }
    }
}

根据告警ID删除活动告警

 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
# 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 = DeleteActiveAlarmsRequest()
        request.domain_id = "{domain_id}"
        metadataEvents = Metadata(
            event_type="alarm",
            event_id="1",
            event_severity="Critical",
            event_name="demo",
            resource_type="日志组/流",
            resource_id="lts-group-demo/lts-topic-demo",
            resource_provider="LTS",
            lts_alarm_type="keywords/sql",
            log_group_name="lts-group-demo",
            log_stream_name="lts-topic-demo"
        )
        listEventsbody = [
            Event(
                metadata=metadataEvents,
                starts_at=1629947408497
            )
        ]
        request.body = DeleteActiveAlarmsRequestBody(
            events=listEventsbody
        )
        response = client.delete_active_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)

根据告警ID删除活动告警

 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
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.DeleteActiveAlarmsRequest{}
	request.DomainId = "{domain_id}"
	logGroupNameMetadata:= "lts-group-demo"
	logStreamNameMetadata:= "lts-topic-demo"
	metadataEvents := &model.Metadata{
		EventType: "alarm",
		EventId: "1",
		EventSeverity: "Critical",
		EventName: "demo",
		ResourceType: "日志组/流",
		ResourceId: "lts-group-demo/lts-topic-demo",
		ResourceProvider: "LTS",
		LtsAlarmType: "keywords/sql",
		LogGroupName: &logGroupNameMetadata,
		LogStreamName: &logStreamNameMetadata,
	}
	var listEventsbody = []model.Event{
        {
            Metadata: metadataEvents,
            StartsAt: int64(1629947408497),
        },
    }
	request.Body = &model.DeleteActiveAlarmsRequestBody{
		Events: listEventsbody,
	}
	response, err := client.DeleteActiveAlarms(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求响应成功。

500

表明服务端能被请求访问到,但是服务内部出错。

错误码

请参见错误码

相关文档