文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 自定义防御规则/ 修改自定义规则 - UpdateCustomRuleConfig
更新时间:2026-08-10 GMT+08:00
分享

修改自定义规则 - UpdateCustomRuleConfig

功能介绍

修改自定义规则

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

PUT /v5/{project_id}/custom/rule/config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

rule_name

String

参数解释

规则名称

约束限制

不涉及

取值范围

字符长度1-64位

默认取值

不涉及

is_all_host

Boolean

参数解释:

是否选择所有主机

约束限制:

不涉及

取值范围:

  • true:是

  • false:否

默认取值:

false

custom_rule_value_info

CustomRuleValueInfo object

agent_ids

Array of strings

参数解释:

agent列表

约束限制:

不涉及

取值范围:

1-1000个agentID

默认取值:

不涉及

rule_id

String

参数解释

规则ID

约束限制

必填

取值范围

字符长度1-36位

默认取值

不涉及

表4 CustomRuleValueInfo

参数

是否必选

参数类型

描述

rule_type

String

参数解释

规则类型

约束限制

必填

取值范围

  • black_hash:黑hash

默认取值

不涉及

hash_type

String

参数解释

hash类型

约束限制

必填

取值范围

  • SHA-256:sha256sum

  • MD5:md5sum

  • SHA-1:sha1sum

默认取值

不涉及

auto_block

Integer

参数解释

是否自动阻断告警

约束限制

必填

取值范围

  • 0:不自动阻断告警

  • 1:自动阻断告警

默认取值

不涉及

rule_values

Array of strings

参数解释

规则集列表

约束限制:

必填

取值范围:

1-1000个规则值

默认取值:

不涉及

响应参数

状态码:200

请求已成功

请求示例

修改自定义规则

PUT https://{endpoint}/v5/{project_id}/custom/rule/config

{
  "rule_name" : "rule_name1",
  "rule_id" : "47421976-688d-41be-b70a-6ed126231611",
  "custom_rule_value_info" : {
    "rule_values" : [ "08a7baa28dd268f8a12bc1f6fd95869321fe51144c5bf3321a6f6305edcd5245" ],
    "hash_type" : "sha256sum",
    "rule_type" : "black_hash",
    "auto_block" : 1
  },
  "agent_ids" : [ "af08124fd77581dcd2a5f7cdaa208c285af0a1480f7ca9b5258193c021ca2636" ]
}

响应示例

SDK代码示例

SDK代码示例如下。

修改自定义规则

 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
64
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.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;

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

public class UpdateCustomRuleConfigSolution {

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

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateCustomRuleConfigRequest request = new UpdateCustomRuleConfigRequest();
        UpdateCustomRuleConfigRequestInfo body = new UpdateCustomRuleConfigRequestInfo();
        List<String> listbodyAgentIds = new ArrayList<>();
        listbodyAgentIds.add("af08124fd77581dcd2a5f7cdaa208c285af0a1480f7ca9b5258193c021ca2636");
        List<String> listCustomRuleValueInfoRuleValues = new ArrayList<>();
        listCustomRuleValueInfoRuleValues.add("08a7baa28dd268f8a12bc1f6fd95869321fe51144c5bf3321a6f6305edcd5245");
        CustomRuleValueInfo customRuleValueInfobody = new CustomRuleValueInfo();
        customRuleValueInfobody.withRuleType("black_hash")
            .withHashType("sha256sum")
            .withAutoBlock(1)
            .withRuleValues(listCustomRuleValueInfoRuleValues);
        body.withAgentIds(listbodyAgentIds);
        body.withRuleName("rule_name1");
        body.withCustomRuleValueInfo(customRuleValueInfobody);
        body.withRuleId("47421976-688d-41be-b70a-6ed126231611");
        request.withBody(body);
        try {
            UpdateCustomRuleConfigResponse response = client.updateCustomRuleConfig(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());
        }
    }
}

修改自定义规则

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 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 = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateCustomRuleConfigRequest()
        listAgentIdsbody = [
            "af08124fd77581dcd2a5f7cdaa208c285af0a1480f7ca9b5258193c021ca2636"
        ]
        listRuleValuesCustomRuleValueInfo = [
            "08a7baa28dd268f8a12bc1f6fd95869321fe51144c5bf3321a6f6305edcd5245"
        ]
        customRuleValueInfobody = CustomRuleValueInfo(
            rule_type="black_hash",
            hash_type="sha256sum",
            auto_block=1,
            rule_values=listRuleValuesCustomRuleValueInfo
        )
        request.body = UpdateCustomRuleConfigRequestInfo(
            agent_ids=listAgentIdsbody,
            rule_name="rule_name1",
            custom_rule_value_info=customRuleValueInfobody,
            rule_id="47421976-688d-41be-b70a-6ed126231611"
        )
        response = client.update_custom_rule_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)

修改自定义规则

 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
64
65
66
67
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := hss.HssClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := hss.NewHssClient(hcClient)

    request := &model.UpdateCustomRuleConfigRequest{}
	var listAgentIdsbody = []string{
        "af08124fd77581dcd2a5f7cdaa208c285af0a1480f7ca9b5258193c021ca2636",
    }
	var listRuleValuesCustomRuleValueInfo = []string{
        "08a7baa28dd268f8a12bc1f6fd95869321fe51144c5bf3321a6f6305edcd5245",
    }
	customRuleValueInfobody := &model.CustomRuleValueInfo{
		RuleType: "black_hash",
		HashType: "sha256sum",
		AutoBlock: int32(1),
		RuleValues: listRuleValuesCustomRuleValueInfo,
	}
	request.Body = &model.UpdateCustomRuleConfigRequestInfo{
		AgentIds: &listAgentIdsbody,
		RuleName: "rule_name1",
		CustomRuleValueInfo: customRuleValueInfobody,
		RuleId: "47421976-688d-41be-b70a-6ed126231611",
	}
	response, err := client.UpdateCustomRuleConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档