# 删除活动告警 - DeleteActiveAlarms #### 功能介绍 该接口用于删除活动告警 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-lts/lts_api_0003.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lts/lts_api_0046.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | lts:alarm:cleanAlarm | Write | - | - | lts:sqlalarms:delete | - | #### URI POST /v2/{project_id}/{domain_id}/lts/alarms/sql-alarm/clear 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，可以从调用API处获取，也可以从控制台获取。获取方式请参见：[获取项目ID](https://support.huaweicloud.com/api-lts/lts_api_0006.html)。 | | domain_id | 是 | String | 账号ID，获取方式请参见：[获取账号ID](https://support.huaweicloud.com/api-lts/lts_api_0012.html) | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 从IAM服务获取的用户Token，获取方式请参见：[获取用户Token](https://support.huaweicloud.com/api-lts/lts_api_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | Content-Type | 是 | String | **参数解释：** 用于定义消息体的格式，该字段填为：application/json;charset=utf8。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | events | 是 | Array of [Event] objects | 主题信息 | 表4Event | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | metadata | 是 | [Metadata] object | 告警信息 最小长度：0 最大长度：2048 | | starts_at | 是 | Long | 告警产生时间(时间戳) | 表5Metadata | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | event_type | 是 | String | **参数解释：** 告警类型。 **取值范围：** alarm | | event_id | 是 | String | **参数解释：** 告警规则ID。 **取值范围：** 不涉及。 | | event_severity | 是 | String | **参数解释：** 告警级别。 **取值范围：** - Info：提示 - Minor：次要 - Major：重要 - Critical：紧急 | | event_name | 是 | String | **参数解释：** 告警规则名称。 **取值范围：** 不涉及。 | | resource_type | 是 | String | **参数解释：** 资源类型。 **取值范围：** 日志组/流 | | resource_id | 是 | String | **参数解释：** 日志组/日志流原始名称。 **取值范围：** 不涉及。 | | resource_provider | 是 | String | **参数解释：** 告警源。 **取值范围：** LTS | | lts_alarm_type | 是 | String | **参数解释：** 告警规则类型。 **取值范围：** - sql： sql告警 - keywords：关键词告警 - search_analysis：搜索分析告警 | | log_group_name | 是 | String | **参数解释：** 日志组原始名称。 **取值范围：** 不涉及。 | | log_stream_name | 是 | String | **参数解释：** 日志流原始名称。 **取值范围：** 不涉及。 | | event_subtype | 是 | String | **参数解释：** 告警类型。 **取值范围：** - sql： sql告警 - keywords：关键词告警 | #### 响应参数 **状态码：200** 请求响应成功。 无 #### 请求示例 根据告警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", "resource_type" : "日志组/流", "event_severity" : "Critical", "resource_id" : "lts-group-demo/lts-topic-demo", "event_name" : "demo", "event_subtype" : "sql", "resource_provider" : "LTS", "log_group_name" : "lts-group-demo", "log_stream_name" : "lts-topic-demo" }, "starts_at" : 1629947408497 } ] } ``` #### 响应示例 无 #### SDK代码示例 SDK代码示例如下。 - [Java] 根据告警ID删除活动告警 ``` 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("")) .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") .withLogGroupName("lts-group-demo") .withLogStreamName("lts-topic-demo") .withEventSubtype("sql"); List 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()); } } } ``` - [Python] 根据告警ID删除活动告警 ``` # 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("")) \ .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", log_group_name="lts-group-demo", log_stream_name="lts-topic-demo", event_subtype="sql" ) 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) ``` - [Go] 根据告警ID删除活动告警 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := lts.LtsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := lts.NewLtsClient(hcClient) request := &model.DeleteActiveAlarmsRequest{} request.DomainId = "{domain_id}" metadataEvents := &model.Metadata{ EventType: "alarm", EventId: "1", EventSeverity: "Critical", EventName: "demo", ResourceType: "日志组/流", ResourceId: "lts-group-demo/lts-topic-demo", ResourceProvider: "LTS", LtsAlarmType: "keywords", LogGroupName: "lts-group-demo", LogStreamName: "lts-topic-demo", EventSubtype: "sql", } 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](https://console.huaweicloud.com/apiexplorer/#/openapi/LTS/sdk?api=DeleteActiveAlarms)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求响应成功。 | | 500 | 表明服务端能被请求访问到，但是服务内部出错。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。