Disabling an Alert Rule
Function
Disable alert rule
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules/disable
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
workspace_id |
Yes |
String |
Workspace ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. You can obtain the token by calling the IAM API used to obtain a user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
[items] |
Yes |
Array of strings |
Request for disabling an alert rule. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
fail_list |
Array of AlertRule objects |
Alert rule ID. |
success_list |
Array of AlertRule objects |
Alert rule ID. |
Parameter |
Type |
Description |
---|---|---|
rule_id |
String |
Alert rule ID. |
pipe_id |
String |
Data pipeline ID. |
pipe_name |
String |
Data pipeline name. |
create_by |
String |
Creator. |
create_time |
Long |
Creation time. |
update_by |
String |
Updater. |
update_time |
Long |
Update time. |
delete_time |
Long |
Deletion time. |
rule_name |
String |
Alert rule name. |
query |
String |
Query statement. |
query_type |
String |
Query syntax: SQL. |
status |
String |
Status. enabled: The rule is enabled. disabled: The rule is disabled. |
severity |
String |
Severity. The options are Informational, Low, Medium, High, and Critical. (TIPS, LOW, MEDIUM, HIGH, FATAL) |
custom_properties |
Map<String,String> |
Custom extension information. |
event_grouping |
Boolean |
Alert group. |
schedule |
Schedule object |
Schedule rule. |
triggers |
Array of AlertRuleTrigger objects |
Alert triggering rules. |
Parameter |
Type |
Description |
---|---|---|
frequency_interval |
Integer |
Scheduling interval. |
frequency_unit |
String |
Scheduling interval unit, which can be minute, hour, or day. (MINUTE, HOUR, DAY) |
period_interval |
Integer |
Time window interval. |
period_unit |
String |
Time window unit, which can be minute, hour, or day. (MINUTE, HOUR, DAY.) |
delay_interval |
Integer |
Delay interval. |
overtime_interval |
Integer |
Timeout interval. |
Parameter |
Type |
Description |
---|---|---|
mode |
String |
Mode and quantity. COUNT. |
operator |
String |
Operator. The value can be: EQ: Equal to NE: Not equal to GT: Greater than LT: Less than |
expression |
String |
expression |
severity |
String |
Severity. The options are Informational, Low, Medium, High, and Critical. (TIPS, LOW, MEDIUM, HIGH, FATAL) |
accumulated_times |
Integer |
accumulated_times |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
Example Requests
Disable an alert rule. Rule ID: 123123.
[ "123123" ]
Example Responses
Status code: 200
Request succeeded.
{
"fail_list" : [ ],
"success_list" : [ ]
}
SDK Sample Code
The SDK sample code is as follows.
Java
Disable an alert rule. Rule ID: 123123.
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 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.secmaster.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;
import java.util.List;
import java.util.ArrayList;
public class DisableAlertRuleSolution {
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);
SecMasterClient client = SecMasterClient.newBuilder()
.withCredential(auth)
.withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
.build();
DisableAlertRuleRequest request = new DisableAlertRuleRequest();
request.withWorkspaceId("{workspace_id}");
List<String> listbodyBody = new ArrayList<>();
listbodyBody.add("123123");
request.withBody(listbodyBody);
try {
DisableAlertRuleResponse response = client.disableAlertRule(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
Disable an alert rule. Rule ID: 123123.
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.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 = SecMasterClient.new_builder() \
.with_credentials(credentials) \
.with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = DisableAlertRuleRequest()
request.workspace_id = "{workspace_id}"
listBodybody = [
"123123"
]
request.body = listBodybody
response = client.disable_alert_rule(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
Disable an alert rule. Rule ID: 123123.
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 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/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 := secmaster.NewSecMasterClient(
secmaster.SecMasterClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.DisableAlertRuleRequest{}
request.WorkspaceId = "{workspace_id}"
var listBodybody = []string{
"123123",
}
request.Body = &listBodybody
response, err := client.DisableAlertRule(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 |
Request succeeded. |
400 |
Request failed. |
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