Ignoring, Unignoring, Repairing, or Verifying the Failed Configuration Check Items

Function

Ignore, unignore, repair, or verify the failed configuration check items.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.
host_id	No	String	Server ID. If this parameter is not specified, all the servers of the user are queried.
action	Yes	String	Action. ignore unignore fix verify

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
check_rules	No	Array of CheckRuleKeyInfoRequestInfo objects	Check item ID list

**Table 5** CheckRuleKeyInfoRequestInfo
Parameter	Mandatory	Type	Description
check_name	No	String	Name of the configuration check (baseline), for example, SSH, CentOS 7, and Windows.
check_rule_id	No	String	Check item ID, which can be obtained from the return data of this API: /v5/{project_id}/baseline/risk-config/{check_name}/check-rules
standard	No	String	Baseline standards. The options are as follows: cn_standard: DJCP MLPS compliance standard hw_standard: Cloud security practice standard
fix_values	No	Array of CheckRuleFixValuesInfo objects	User-entered repair parameters of check items

**Table 6** CheckRuleFixValuesInfo
Parameter	Mandatory	Type	Description
rule_param_id	No	Integer	Parameter ID of the check item
fix_value	No	Integer	Parameter value of the check item

Response Parameters

None

Example Requests

This API is used to ignore the configuration check items whose baseline name is SSH, check item ID is 1.11, check standard is cloud security practice standard, and enterprise project ID is xxx. This operation applies to all affected servers.
```
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"
  } ]
}
```
This API is used to restore the configuration check items whose baseline name is SSH, check item ID is 1.11, check standard is cloud security practice standard, and enterprise project ID is xxx. This operation applies only to the server whose ID is xxx. The restoration parameters are as follows: Set the value of the repair item whose ID is 1 to 5 and the value of the repair item whose ID is 2 to 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
    } ]
  } ]
}
```

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

This API is used to ignore the configuration check items whose baseline name is SSH, check item ID is 1.11, check standard is cloud security practice standard, and enterprise project ID is xxx. This operation applies to all affected servers.

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

            

          

        
       

This API is used to restore the configuration check items whose baseline name is SSH, check item ID is 1.11, check standard is cloud security practice standard, and enterprise project ID is xxx. This operation applies only to the server whose ID is xxx. The restoration parameters are as follows: Set the value of the repair item whose ID is 1 to 5 and the value of the repair item whose ID is 2 to 20.

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

            

          

        
       

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

            

          

        
       

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

            

          

        
       

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

            

          

        
       

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

            

          

        
       