Deleting an Active Alarm
Function
This API is used to delete an active alarm.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/{domain_id}/lts/alarms/sql-alarm/clear
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 |
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 |
---|---|---|---|
events |
Yes |
Array of Event objects |
Topic information. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
metadata |
Yes |
Metadata object |
Alarm information. Minimum length: 0 Maximum length: 2048 |
starts_at |
Yes |
Long |
Alarm generation time (timestamp). Minimum: 0 Maximum: 32 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
event_type |
Yes |
String |
Alarm type. Minimum: 1 Maximum: 1024 |
event_id |
Yes |
String |
Alarm ID. Minimum: 1 Maximum: 1024 |
event_severity |
Yes |
String |
Alarm severity. Minimum: 1 Maximum: 1024 |
event_name |
Yes |
String |
Alarm name. Minimum: 1 Maximum: 1024 |
resource_type |
Yes |
String |
Resource type. Minimum: 1 Maximum: 1024 |
resource_id |
Yes |
String |
Log group/stream name. Minimum: 1 Maximum: 1024 |
resource_provider |
Yes |
String |
Alarm source. Minimum: 1 Maximum: 1024 |
lts_alarm_type |
Yes |
String |
Alarm rule type (SQL/keyword). Minimum: 1 Maximum: 100 |
Response Parameters
None
Example Requests
Deleting an active alarm by alarm 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" : "Log group/stream", "event_severity" : "Critical", "resource_id" : "lts-group-demo/lts-topic-demo", "event_name" : "demo", "resource_provider" : "LTS" }, "starts_at" : 1629947408497 } ] }
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Deleting an active alarm by alarm 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 |
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(); DeleteActiveAlarmsRequestBody body = new DeleteActiveAlarmsRequestBody(); Metadata metadataEvents = new Metadata(); metadataEvents.withEventType("alarm") .withEventId("1") .withEventSeverity("Critical") .withEventName("demo") .withResourceType("Log group/stream") .withResourceId("lts-group-demo/lts-topic-demo") .withResourceProvider("LTS") .withLtsAlarmType("keywords/sql"); 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()); } } } |
Deleting an active alarm by alarm 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 |
# 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() metadataEvents = Metadata( event_type="alarm", event_id="1", event_severity="Critical", event_name="demo", resource_type="Log group/stream", resource_id="lts-group-demo/lts-topic-demo", resource_provider="LTS", lts_alarm_type="keywords/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) |
Deleting an active alarm by alarm 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 |
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{} metadataEvents := &model.Metadata{ EventType: "alarm", EventId: "1", EventSeverity: "Critical", EventName: "demo", ResourceType: "Log group/stream", ResourceId: "lts-group-demo/lts-topic-demo", ResourceProvider: "LTS", LtsAlarmType: "keywords/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) } } |
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. |
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