Help Center/ Log Tank Service/ API Reference/ APIs/ Keyword Alarm Rules/ Deleting a Keyword Alarm Rule
Updated on 2025-08-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting a Keyword Alarm Rule

Function

This API is used to delete a keyword alarm.

Calling Method

For details, see Calling APIs.

URI

DELETE /v2/{project_id}/lts/alarms/keywords-alarm-rule/{keywords_alarm_rule_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. It can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

keywords_alarm_rule_id

Yes

String

Definition

Keyword alarm rule ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Message body format. Set this parameter to application/json;charset=utf8.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

The request is successful.

Status code: 500

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code. For details, see Error Codes.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Example Requests

Delete a keyword alarm by alarm ID.

POST https://{endpoint}/v2/{project_id}/lts/alarms/keywords-alarm-rule/{keywords_alarm_rule_id}

/v2/{project_id}/lts/alarms/keywords-alarm-rule/{keywords_alarm_rule_id}

Example Responses

Status code: 500

The server has received the request but encountered an internal error.

{
  "error_code" : "LTS.2002",
  "error_msg" : "Failed to update alarm rule."
}

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.

Parent Topic: Keyword Alarm Rules