更新时间:2025-01-03 GMT+08:00
分享

修改告警配置接口

功能介绍

修改告警配置接口

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/cfw/alarm/config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,可以从调API处获取,也可以从控制台获取。可通过项目ID获取方式获取

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

String

防火墙ID,可通过防火墙ID获取方式获取

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,可通过如何获取用户Token获取

表4 请求Body参数

参数

是否必选

参数类型

描述

account_name

String

账号名称

alarm_id

String

告警id

alarm_time_period

Integer

告警周期,0:全天,1:8时到22时

alarm_type

Integer

告警类型 0:攻击告警; 1:流量超额预警; 2:EIP未防护告警; 3:威胁情报告警

enable_status

Integer

告警状态 0:失效; 1:生效

frequency_count

Integer

告警触发频次

frequency_time

Integer

告警频次时间范围

language

String

告警语言

severity

String

告警等级

topic_urn

String

告警urn

username

String

用户名称

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

data

ResponseData object

通用返回体

表6 ResponseData

参数

参数类型

描述

id

String

数据id

请求示例

配置项目id为408972e72dcd4c1a9b033e955802a36b的防火墙告警,防火墙id为8de37729-026d-412f-ba82-80c46f388d14。告警类型为1,告警时间周期为0,启用状态为0,严重程度为0。告警策略为防护带宽使用率达到80%时,每天告警一次。告警名称为test-wyl,主题URN为urn:smn:cn-north-7:408972e72dcd4c1a9b033e955802a36b:test-wyl。

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/alarm/config?fw_instance_id=8de37729-026d-412f-ba82-80c46f388d14

{
  "alarm_time_period" : 0,
  "alarm_type" : 1,
  "enable_status" : 0,
  "severity" : "0",
  "frequency_count" : 1,
  "frequency_time" : 1,
  "topic_urn" : "urn:smn:cn-north-7:408972e72dcd4c1a9b033e955802a36b:test-wyl"
}

响应示例

状态码: 200

OK

{
  "data" : {
    "id" : "8de37729-026d-412f-ba82-80c46f388d14"
  }
}

SDK代码示例

SDK代码示例如下。

Java

配置项目id为408972e72dcd4c1a9b033e955802a36b的防火墙告警,防火墙id为8de37729-026d-412f-ba82-80c46f388d14。告警类型为1,告警时间周期为0,启用状态为0,严重程度为0。告警策略为防护带宽使用率达到80%时,每天告警一次。告警名称为test-wyl,主题URN为urn:smn:cn-north-7:408972e72dcd4c1a9b033e955802a36b:test-wyl。

 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
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.cfw.v1.region.CfwRegion;
import com.huaweicloud.sdk.cfw.v1.*;
import com.huaweicloud.sdk.cfw.v1.model.*;


public class UpdateAlarmConfigSolution {

    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);

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateAlarmConfigRequest request = new UpdateAlarmConfigRequest();
        UpdateAttackLogAlarmConfigDto body = new UpdateAttackLogAlarmConfigDto();
        body.withTopicUrn("urn:smn:cn-north-7:408972e72dcd4c1a9b033e955802a36b:test-wyl");
        body.withSeverity("0");
        body.withFrequencyTime(1);
        body.withFrequencyCount(1);
        body.withEnableStatus(0);
        body.withAlarmType(1);
        body.withAlarmTimePeriod(0);
        request.withBody(body);
        try {
            UpdateAlarmConfigResponse response = client.updateAlarmConfig(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为408972e72dcd4c1a9b033e955802a36b的防火墙告警,防火墙id为8de37729-026d-412f-ba82-80c46f388d14。告警类型为1,告警时间周期为0,启用状态为0,严重程度为0。告警策略为防护带宽使用率达到80%时,每天告警一次。告警名称为test-wyl,主题URN为urn:smn:cn-north-7:408972e72dcd4c1a9b033e955802a36b:test-wyl。

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.v1 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 = CfwClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CfwRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateAlarmConfigRequest()
        request.body = UpdateAttackLogAlarmConfigDto(
            topic_urn="urn:smn:cn-north-7:408972e72dcd4c1a9b033e955802a36b:test-wyl",
            severity="0",
            frequency_time=1,
            frequency_count=1,
            enable_status=0,
            alarm_type=1,
            alarm_time_period=0
        )
        response = client.update_alarm_config(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为408972e72dcd4c1a9b033e955802a36b的防火墙告警,防火墙id为8de37729-026d-412f-ba82-80c46f388d14。告警类型为1,告警时间周期为0,启用状态为0,严重程度为0。告警策略为防护带宽使用率达到80%时,每天告警一次。告警名称为test-wyl,主题URN为urn:smn:cn-north-7:408972e72dcd4c1a9b033e955802a36b:test-wyl。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/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 := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateAlarmConfigRequest{}
	topicUrnUpdateAttackLogAlarmConfigDto:= "urn:smn:cn-north-7:408972e72dcd4c1a9b033e955802a36b:test-wyl"
	severityUpdateAttackLogAlarmConfigDto:= "0"
	frequencyTimeUpdateAttackLogAlarmConfigDto:= int32(1)
	frequencyCountUpdateAttackLogAlarmConfigDto:= int32(1)
	enableStatusUpdateAttackLogAlarmConfigDto:= int32(0)
	alarmTypeUpdateAttackLogAlarmConfigDto:= int32(1)
	alarmTimePeriodUpdateAttackLogAlarmConfigDto:= int32(0)
	request.Body = &model.UpdateAttackLogAlarmConfigDto{
		TopicUrn: &topicUrnUpdateAttackLogAlarmConfigDto,
		Severity: &severityUpdateAttackLogAlarmConfigDto,
		FrequencyTime: &frequencyTimeUpdateAttackLogAlarmConfigDto,
		FrequencyCount: &frequencyCountUpdateAttackLogAlarmConfigDto,
		EnableStatus: &enableStatusUpdateAttackLogAlarmConfigDto,
		AlarmType: &alarmTypeUpdateAttackLogAlarmConfigDto,
		AlarmTimePeriod: &alarmTimePeriodUpdateAttackLogAlarmConfigDto,
	}
	response, err := client.UpdateAlarmConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档