文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 基线管理/ 对未通过的配置检查项进行忽略/取消忽略/修复/验证操作
更新时间:2024-11-19 GMT+08:00

对未通过的配置检查项进行忽略/取消忽略/修复/验证操作

功能介绍

对未通过的配置检查项进行忽略/取消忽略/修复/验证操作

调用方法

请参见如何调用API

URI

PUT /v5/{project_id}/baseline/check-rule/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID,查询所有企业项目时填写:all_granted_eps

host_id

String

主机ID,不赋值时,查租户所有主机

action

String

动作

  • "ignore"

  • "unignore"

  • "fix"

  • "verify"

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

表4 请求Body参数

参数

是否必选

参数类型

描述

check_rules

Array of CheckRuleKeyInfoRequestInfo objects

检查项ID列表

表5 CheckRuleKeyInfoRequestInfo

参数

是否必选

参数类型

描述

check_name

String

配置检查(基线)的名称,例如SSH、CentOS 7、Windows

check_rule_id

String

检查项ID,值可以通过这个接口的返回数据获得:/v5/{project_id}/baseline/risk-config/{check_name}/check-rules

standard

String

基线标准, 类别包含如下:

  • cn_standard#等保合规标准

  • hw_standard#云安全实践标准

fix_values

Array of CheckRuleFixValuesInfo objects

用户键入的检查项修复参数数组

表6 CheckRuleFixValuesInfo

参数

是否必选

参数类型

描述

rule_param_id

Integer

检查项的参数ID

fix_value

Integer

检查项的参数值

响应参数

请求示例

  • 对企业项目id为xxx下的基线名称为SSH、检查项ID为1.11、检查标准为云安全实践标准的配置检查项进行忽略操作,此操作针对这条检查项的所有受影响主机。

    PUT https://{endpoint}/v5/{project_id}/baseline/check-rule/action?enterprise_project_id=xxx&action=ignore
    
    {
      "check_rules" : [ {
        "check_name" : "SSH",
        "check_rule_id" : "1.11",
        "standard" : "hw_standard"
      } ]
    }
  • 对企业项目id为xxx下的基线名称为SSH、检查项ID为1.11、检查标准为云安全实践标准的配置检查项进行修复操作,此操作只针对主机id为xxx的主机,修复参数为:将ID为1的修复项值设置为5,将ID为2的修复项值设置为20。

    PUT https://{endpoint}/v5/{project_id}/baseline/check-rule/action?enterprise_project_id=xxx&host_id=xxx&action=fix
    
    {
      "check_rules" : [ {
        "check_name" : "SSH",
        "check_rule_id" : "1.11",
        "standard" : "hw_standard",
        "fix_values" : [ {
          "rule_param_id" : 1,
          "fix_value" : 5
        }, {
          "rule_param_id" : 2,
          "fix_value" : 20
        } ]
      } ]
    }

响应示例

SDK代码示例

SDK代码示例如下。

  • 对企业项目id为xxx下的基线名称为SSH、检查项ID为1.11、检查标准为云安全实践标准的配置检查项进行忽略操作,此操作针对这条检查项的所有受影响主机。

     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
    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 ChangeCheckRuleActionSolution {
    
        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();
            ChangeCheckRuleActionRequest request = new ChangeCheckRuleActionRequest();
            CheckRuleIdListRequestInfo body = new CheckRuleIdListRequestInfo();
            List<CheckRuleKeyInfoRequestInfo> listbodyCheckRules = new ArrayList<>();
            listbodyCheckRules.add(
                new CheckRuleKeyInfoRequestInfo()
                    .withCheckName("SSH")
                    .withCheckRuleId("1.11")
                    .withStandard("hw_standard")
            );
            body.withCheckRules(listbodyCheckRules);
            request.withBody(body);
            try {
                ChangeCheckRuleActionResponse response = client.changeCheckRuleAction(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());
            }
        }
    }
    
  • 对企业项目id为xxx下的基线名称为SSH、检查项ID为1.11、检查标准为云安全实践标准的配置检查项进行修复操作,此操作只针对主机id为xxx的主机,修复参数为:将ID为1的修复项值设置为5,将ID为2的修复项值设置为20。

     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
    68
    69
    70
    71
    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 ChangeCheckRuleActionSolution {
    
        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();
            ChangeCheckRuleActionRequest request = new ChangeCheckRuleActionRequest();
            CheckRuleIdListRequestInfo body = new CheckRuleIdListRequestInfo();
            List<CheckRuleFixValuesInfo> listCheckRulesFixValues = new ArrayList<>();
            listCheckRulesFixValues.add(
                new CheckRuleFixValuesInfo()
                    .withRuleParamId(1)
                    .withFixValue(5)
            );
            listCheckRulesFixValues.add(
                new CheckRuleFixValuesInfo()
                    .withRuleParamId(2)
                    .withFixValue(20)
            );
            List<CheckRuleKeyInfoRequestInfo> listbodyCheckRules = new ArrayList<>();
            listbodyCheckRules.add(
                new CheckRuleKeyInfoRequestInfo()
                    .withCheckName("SSH")
                    .withCheckRuleId("1.11")
                    .withStandard("hw_standard")
                    .withFixValues(listCheckRulesFixValues)
            );
            body.withCheckRules(listbodyCheckRules);
            request.withBody(body);
            try {
                ChangeCheckRuleActionResponse response = client.changeCheckRuleAction(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());
            }
        }
    }
    
  • 对企业项目id为xxx下的基线名称为SSH、检查项ID为1.11、检查标准为云安全实践标准的配置检查项进行忽略操作,此操作针对这条检查项的所有受影响主机。

     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
    # 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 = ChangeCheckRuleActionRequest()
            listCheckRulesbody = [
                CheckRuleKeyInfoRequestInfo(
                    check_name="SSH",
                    check_rule_id="1.11",
                    standard="hw_standard"
                )
            ]
            request.body = CheckRuleIdListRequestInfo(
                check_rules=listCheckRulesbody
            )
            response = client.change_check_rule_action(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • 对企业项目id为xxx下的基线名称为SSH、检查项ID为1.11、检查标准为云安全实践标准的配置检查项进行修复操作,此操作只针对主机id为xxx的主机,修复参数为:将ID为1的修复项值设置为5,将ID为2的修复项值设置为20。

     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
    # 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 = ChangeCheckRuleActionRequest()
            listFixValuesCheckRules = [
                CheckRuleFixValuesInfo(
                    rule_param_id=1,
                    fix_value=5
                ),
                CheckRuleFixValuesInfo(
                    rule_param_id=2,
                    fix_value=20
                )
            ]
            listCheckRulesbody = [
                CheckRuleKeyInfoRequestInfo(
                    check_name="SSH",
                    check_rule_id="1.11",
                    standard="hw_standard",
                    fix_values=listFixValuesCheckRules
                )
            ]
            request.body = CheckRuleIdListRequestInfo(
                check_rules=listCheckRulesbody
            )
            response = client.change_check_rule_action(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • 对企业项目id为xxx下的基线名称为SSH、检查项ID为1.11、检查标准为云安全实践标准的配置检查项进行忽略操作,此操作针对这条检查项的所有受影响主机。

     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
    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 := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            Build()
    
        client := hss.NewHssClient(
            hss.HssClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.ChangeCheckRuleActionRequest{}
    	checkNameCheckRules:= "SSH"
    	checkRuleIdCheckRules:= "1.11"
    	standardCheckRules:= "hw_standard"
    	var listCheckRulesbody = []model.CheckRuleKeyInfoRequestInfo{
            {
                CheckName: &checkNameCheckRules,
                CheckRuleId: &checkRuleIdCheckRules,
                Standard: &standardCheckRules,
            },
        }
    	request.Body = &model.CheckRuleIdListRequestInfo{
    		CheckRules: &listCheckRulesbody,
    	}
    	response, err := client.ChangeCheckRuleAction(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • 对企业项目id为xxx下的基线名称为SSH、检查项ID为1.11、检查标准为云安全实践标准的配置检查项进行修复操作,此操作只针对主机id为xxx的主机,修复参数为:将ID为1的修复项值设置为5,将ID为2的修复项值设置为20。

     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
    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 := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            Build()
    
        client := hss.NewHssClient(
            hss.HssClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.ChangeCheckRuleActionRequest{}
    	ruleParamIdFixValues:= int32(1)
    	fixValueFixValues:= int32(5)
    	ruleParamIdFixValues1:= int32(2)
    	fixValueFixValues1:= int32(20)
    	var listFixValuesCheckRules = []model.CheckRuleFixValuesInfo{
            {
                RuleParamId: &ruleParamIdFixValues,
                FixValue: &fixValueFixValues,
            },
            {
                RuleParamId: &ruleParamIdFixValues1,
                FixValue: &fixValueFixValues1,
            },
        }
    	checkNameCheckRules:= "SSH"
    	checkRuleIdCheckRules:= "1.11"
    	standardCheckRules:= "hw_standard"
    	var listCheckRulesbody = []model.CheckRuleKeyInfoRequestInfo{
            {
                CheckName: &checkNameCheckRules,
                CheckRuleId: &checkRuleIdCheckRules,
                Standard: &standardCheckRules,
                FixValues: &listFixValuesCheckRules,
            },
        }
    	request.Body = &model.CheckRuleIdListRequestInfo{
    		CheckRules: &listCheckRulesbody,
    	}
    	response, err := client.ChangeCheckRuleAction(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    

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

状态码

状态码

描述

200

执行成功

错误码

请参见错误码