文档首页/ 云日志服务 LTS/ API参考/ API说明/ SQL告警规则/ 切换告警规则状态

更新时间：2024-08-29 GMT+08:00

在线调试

CLI示例

查看PDF

切换告警规则状态

功能介绍

该接口用于告警规则的启动与停止

调用方法

请参见如何调用API。

URI

PUT /v2/{project_id}/lts/alarms/status

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	从IAM服务获取的用户Token，获取方式请参见：获取用户Token
Content-Type	是	String	该字段填为：application/json;charset=UTF-8。

表3 请求Body参数
参数	是否必选	参数类型	描述
alarm_rule_id	是	String	告警规则id。
type	是	String	告警规则类型“sql”或“keywords”。
status	是	String	RUNNING开启告警规则,STOPPING停止告警规则。

响应参数

状态码： 401

表4 响应Body参数
参数	参数类型	描述
error_code	String	错误码示例。
error_msg	String	调用失败响应信息描述。

状态码： 500

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码示例。
error_msg	String	调用失败响应信息描述。

请求示例

启用指定告警规则ID的告警规则。“type”类型为："sql"；"status"类型为： "RUNNING" 。

PUT https://{endpoint}/v2/{project_id}/lts/alarms/status 

{
  "alarm_rule_id" : "ABCDEFG",
  "type" : "sql",
  "status" : "RUNNING"
}

“type”类型为："keywords"；"status"类型为： "STOPPING"。

PUT https://{endpoint}/v2/{project_id}/lts/alarms/status 

{
  "alarm_rule_id" : "ABCDEFG",
  "type" : "keywords",
  "status" : "STOPPING"
}

响应示例

状态码： 401

项目id验证错误。

{
  "error_code" : "LTS.0001",
  "error_msg" : "Project verify error."
}

状态码： 500

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

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

SDK代码示例

SDK代码示例如下。

启用指定告警规则ID的告警规则。“type”类型为："sql"；"status"类型为： "RUNNING" 。

        
         
           
           
             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.*;


public class UpdateAlarmRuleStatusSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateAlarmRuleStatusRequest request = new UpdateAlarmRuleStatusRequest();
        ChangeAlarmRuleStatus body = new ChangeAlarmRuleStatus();
        body.withType("sql");
        body.withStatus("RUNNING");
        body.withAlarmRuleId("ABCDEFG");
        request.withBody(body);
        try {
            UpdateAlarmRuleStatusResponse response = client.updateAlarmRuleStatus(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());
        }
    }
}

            

          

        
       

“type”类型为："keywords"；"status"类型为： "STOPPING"。

        
         
           
           
             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.*;


public class UpdateAlarmRuleStatusSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateAlarmRuleStatusRequest request = new UpdateAlarmRuleStatusRequest();
        ChangeAlarmRuleStatus body = new ChangeAlarmRuleStatus();
        body.withType("keywords");
        body.withStatus("STOPPING");
        body.withAlarmRuleId("ABCDEFG");
        request.withBody(body);
        try {
            UpdateAlarmRuleStatusResponse response = client.updateAlarmRuleStatus(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的告警规则。“type”类型为："sql"；"status"类型为： "RUNNING" 。

        
         
           
           
             # 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateAlarmRuleStatusRequest()
        request.body = ChangeAlarmRuleStatus(
            type="sql",
            status="RUNNING",
            alarm_rule_id="ABCDEFG"
        )
        response = client.update_alarm_rule_status(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

“type”类型为："keywords"；"status"类型为： "STOPPING"。

        
         
           
           
             # 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateAlarmRuleStatusRequest()
        request.body = ChangeAlarmRuleStatus(
            type="keywords",
            status="STOPPING",
            alarm_rule_id="ABCDEFG"
        )
        response = client.update_alarm_rule_status(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的告警规则。“type”类型为："sql"；"status"类型为： "RUNNING" 。

        
         
           
           
             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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateAlarmRuleStatusRequest{}
	request.Body = &model.ChangeAlarmRuleStatus{
		Type: "sql",
		Status: "RUNNING",
		AlarmRuleId: "ABCDEFG",
	}
	response, err := client.UpdateAlarmRuleStatus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

“type”类型为："keywords"；"status"类型为： "STOPPING"。

        
         
           
           
             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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateAlarmRuleStatusRequest{}
	request.Body = &model.ChangeAlarmRuleStatus{
		Type: "keywords",
		Status: "STOPPING",
		AlarmRuleId: "ABCDEFG",
	}
	response, err := client.UpdateAlarmRuleStatus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

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

状态码

状态码	描述
200	请求响应成功。
401	项目id验证错误。
500	表明服务端能被请求访问到，但是服务内部出错。

错误码

请参见错误码。

父主题： SQL告警规则

上一篇：删除SQL告警规则

下一篇：关键词告警规则

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消