Modifying Alarm Configurations
Function
This API is used to modify alarm configurations.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/cfw/alarm/config
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID, which can be obtained by calling an API or from the console. You can obtain it by referring to Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
fw_instance_id |
Yes |
String |
Firewall ID, which can be obtained by referring to Obtaining a Firewall ID. |
enterprise_project_id |
No |
String |
Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token, which can be obtained by referring to Obtaining a User Token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
account_name |
No |
String |
Account name. |
alarm_id |
No |
String |
Alarm ID. |
alarm_time_period |
No |
Integer |
Alarm period: 0 (all day), 1 (8:00 to 22:00). |
alarm_type |
No |
Integer |
Alarm type: 0 (attack), 1 (traffic threshold crossing), 2 (EIP unprotected), 3 (threat intelligence) |
enable_status |
No |
Integer |
Alarm status: 0 (invalid), 1 (valid). |
frequency_count |
No |
Integer |
Alarm triggering frequency. |
frequency_time |
No |
Integer |
Alarm frequency time range. |
language |
No |
String |
Alarm language. |
severity |
No |
String |
Alarm severity. |
topic_urn |
No |
String |
Alarm URN. |
username |
No |
String |
Username. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
ResponseData object |
Common response body. |
Example Requests
Configure the firewall alarms of the project whose ID is eefb11b22d5944f2aa067954516df1cf. The firewall ID is 8de37729-026d-412f-ba82-80c46f388d14. The alarm type is 1, alarm period is 0, status is 0, and severity is 0. The alarm policy is that an alarm is generated once a day when the protection bandwidth usage reaches 80%. The alarm name is test-wyl, and the topic URN is urn:smn:cn-north-7:eefb11b22d5944f2aa067954516df1cf: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" }
Example Responses
Status code: 200
OK
{ "data" : { "id" : "8de37729-026d-412f-ba82-80c46f388d14" } }
SDK Sample Code
The SDK sample code is as follows.
Java
Configure the firewall alarms of the project whose ID is eefb11b22d5944f2aa067954516df1cf. The firewall ID is 8de37729-026d-412f-ba82-80c46f388d14. The alarm type is 1, alarm period is 0, status is 0, and severity is 0. The alarm policy is that an alarm is generated once a day when the protection bandwidth usage reaches 80%. The alarm name is test-wyl, and the topic URN is urn:smn:cn-north-7:eefb11b22d5944f2aa067954516df1cf: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
Configure the firewall alarms of the project whose ID is eefb11b22d5944f2aa067954516df1cf. The firewall ID is 8de37729-026d-412f-ba82-80c46f388d14. The alarm type is 1, alarm period is 0, status is 0, and severity is 0. The alarm policy is that an alarm is generated once a day when the protection bandwidth usage reaches 80%. The alarm name is test-wyl, and the topic URN is urn:smn:cn-north-7:eefb11b22d5944f2aa067954516df1cf: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
Configure the firewall alarms of the project whose ID is eefb11b22d5944f2aa067954516df1cf. The firewall ID is 8de37729-026d-412f-ba82-80c46f388d14. The alarm type is 1, alarm period is 0, status is 0, and severity is 0. The alarm policy is that an alarm is generated once a day when the protection bandwidth usage reaches 80%. The alarm name is test-wyl, and the topic URN is urn:smn:cn-north-7:eefb11b22d5944f2aa067954516df1cf: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) } } |
More
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 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
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