Updated on 2026-02-05 GMT+08:00

Creating a Preprocessing Rule

Function

This API is used to create a preprocessing rule.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/mappings/preprocess-rules

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Range

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

project_id

No

String

Mapping ID.

workspace_id

No

String

Mapping ID.

mapping_id

Yes

String

Mapping ID.

preprocess_rules

No

Array of preprocess_rules objects

Preprocessing rule list.

Table 4 preprocess_rules

Parameter

Mandatory

Type

Description

name

No

String

Name.

mapper_id

No

String

Mapping ID.

mapper_type_id

No

String

Mapping ID.

action

No

String

Preprocessing option: drop.

expression

No

String

Expression.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

data

data object

Data.

Table 6 data

Parameter

Type

Description

project_id

String

Mapping ID.

workspace_id

String

Mapping ID.

mapping_id

String

Mapping ID.

preprocess_rules

Array of preprocess_rules objects

Preprocessing rule list.

Table 7 preprocess_rules

Parameter

Type

Description

id

String

Mapping ID.

name

String

Name.

mapper_id

String

Mapping ID.

mapper_type_id

String

Mapping ID.

action

String

Preprocessing option: drop.

expression

String

Expression.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

Create a preprocessing rule.

{
  "workspace_id" : "57b5073d-9026-423f-96c3-2f427e5c008f",
  "mapping_id" : "b8ab9440-9603-4ee2-87ef-056c51dc2abf",
  "preprocess_rules" : [ {
    "name" : "Global ICMP Abnormal",
    "mapper_id" : "03689b2c-cba5-3665-9805-fe675b66d90f",
    "mapper_type_id" : "aa123ba5c76e48e9e7161ddc238d2351",
    "action" : "drop"
  } ]
}

Example Responses

Status code: 200

Response to the request for creating a preprocessing rule.

{
  "code" : "00000000",
  "data" : {
    "mapping_id" : "b8ab9440-9603-4ee2-87ef-056c51dc2abf",
    "preprocess_rules" : [ {
      "action" : "drop",
      "expression" : "",
      "id" : "1c7d66d9-df5b-4113-89f5-2ca74362be54",
      "mapper_id" : "03689b2c-cba5-3665-9805-fe675b66d90f",
      "mapper_type_id" : "aa123ba5c76e48e9e7161ddc238d2351",
      "name" : "Global ICMP Abnormal"
    } ],
    "project_id" : "15645222e8744afa985c93dab6341da6",
    "workspace_id" : "57b5073d-9026-423f-96c3-2f427e5c008f"
  },
  "message" : ""
}

SDK Sample Code

The SDK sample code is as follows.

Create a preprocessing rule.

 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
57
58
59
60
61
62
63
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.v1.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v1.*;
import com.huaweicloud.sdk.secmaster.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreatePreProcessRulesSolution {

    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();
        CreatePreProcessRulesRequest request = new CreatePreProcessRulesRequest();
        request.withWorkspaceId("{workspace_id}");
        CreatePreProcessRulesRequestBody body = new CreatePreProcessRulesRequestBody();
        List<CreatePreProcessRulesRequestBodyPreprocessRules> listbodyPreprocessRules = new ArrayList<>();
        listbodyPreprocessRules.add(
            new CreatePreProcessRulesRequestBodyPreprocessRules()
                .withName("Global ICMP Abnormal")
                .withMapperId("03689b2c-cba5-3665-9805-fe675b66d90f")
                .withMapperTypeId("aa123ba5c76e48e9e7161ddc238d2351")
                .withAction(CreatePreProcessRulesRequestBodyPreprocessRules.ActionEnum.fromValue("drop"))
        );
        body.withPreprocessRules(listbodyPreprocessRules);
        body.withMappingId("b8ab9440-9603-4ee2-87ef-056c51dc2abf");
        body.withWorkspaceId("57b5073d-9026-423f-96c3-2f427e5c008f");
        request.withBody(body);
        try {
            CreatePreProcessRulesResponse response = client.createPreProcessRules(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());
        }
    }
}

Create a preprocessing rule.

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.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 = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreatePreProcessRulesRequest()
        request.workspace_id = "{workspace_id}"
        listPreprocessRulesbody = [
            CreatePreProcessRulesRequestBodyPreprocessRules(
                name="Global ICMP Abnormal",
                mapper_id="03689b2c-cba5-3665-9805-fe675b66d90f",
                mapper_type_id="aa123ba5c76e48e9e7161ddc238d2351",
                action="drop"
            )
        ]
        request.body = CreatePreProcessRulesRequestBody(
            preprocess_rules=listPreprocessRulesbody,
            mapping_id="b8ab9440-9603-4ee2-87ef-056c51dc2abf",
            workspace_id="57b5073d-9026-423f-96c3-2f427e5c008f"
        )
        response = client.create_pre_process_rules(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Create a preprocessing rule.

 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 main

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

    request := &model.CreatePreProcessRulesRequest{}
	request.WorkspaceId = "{workspace_id}"
	namePreprocessRules:= "Global ICMP Abnormal"
	mapperIdPreprocessRules:= "03689b2c-cba5-3665-9805-fe675b66d90f"
	mapperTypeIdPreprocessRules:= "aa123ba5c76e48e9e7161ddc238d2351"
	actionPreprocessRules:= model.GetCreatePreProcessRulesRequestBodyPreprocessRulesActionEnum().DROP
	var listPreprocessRulesbody = []model.CreatePreProcessRulesRequestBodyPreprocessRules{
        {
            Name: &namePreprocessRules,
            MapperId: &mapperIdPreprocessRules,
            MapperTypeId: &mapperTypeIdPreprocessRules,
            Action: &actionPreprocessRules,
        },
    }
	workspaceIdCreatePreProcessRulesRequestBody:= "57b5073d-9026-423f-96c3-2f427e5c008f"
	request.Body = &model.CreatePreProcessRulesRequestBody{
		PreprocessRules: &listPreprocessRulesbody,
		MappingId: "b8ab9440-9603-4ee2-87ef-056c51dc2abf",
		WorkspaceId: &workspaceIdCreatePreProcessRulesRequestBody,
	}
	response, err := client.CreatePreProcessRules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

Response to the request for creating a preprocessing rule.

400

Returned packet for abnormal requests.

Error Codes

See Error Codes.