Help Center/ Host Security Service/ API Reference/ API Description/ Baseline check/ Querying the Impact Scope of a Baseline Check
Updated on 2025-08-15 GMT+08:00

Querying the Impact Scope of a Baseline Check

Function

This API is used to query the impact scope of a baseline check.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/baseline/check-rule/handle-affect-baseline

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

offset

Yes

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

N/A

limit

Yes

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10 to 200

Default Value

10

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Details:

Operation performed during the baseline check

Constraints

N/A

Value Range

  • add_to_whitelist

  • ignore

  • unignore

  • fix

  • verify

Default value:

N/A

handle_status

Yes

String

Details:

Status of the current check items

Constraints

N/A

Value Range

  • unhandled

  • fix-failed

  • fixing

  • verifying

  • ignored

  • safe

Default value:

N/A

host_id

No

String

Details:

Host ID. If this field does not exist, the check item affects some hosts.

Constraints

N/A

Value Range

The value contains 1 to 256 characters.

Default value:

N/A

check_rule_list

Yes

Array of check_rule_list objects

Details:

Check items to be operated

Constraints

List range: 0 - 200

Table 5 check_rule_list

Parameter

Mandatory

Type

Description

check_name

No

String

Details:

Name of a baseline check

Constraints

N/A

Value Range

The value contains 0 to 256 characters.

Default value:

N/A

check_rule_id

No

String

Details:

Check item ID.

Constraints

N/A

Value Range

The value contains 0 to 256 characters.

Default value:

N/A

standard

No

String

Details:

Baseline check standard type

Constraints

N/A

Value Range

  • cn_standard: DJCP MLPS compliance standard

  • hw_standard: Cloud security practice standard

cis_standard: general security standard

Default value:

N/A

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

total_rule_num

Integer

Details:

Total number of affected items

Value Range

0 to 5000

rule_num

Integer

Details:

Number of check items affected by the operation

Value Range

0 to 5000

host_num

Integer

Details:

Number of hosts affected by the operation

Value Range

0 to 5000

data_list

Array of HandleAffectBaselineInfo objects

Details:

Detailed information about the operation impact scope

Table 7 HandleAffectBaselineInfo

Parameter

Type

Description

host_id

String

Details:

Host ID.

Value Range

The value contains 1 to 256 characters.

host_name

String

Details:

Server Name

Value Range

The value contains 1 to 64 characters.

public_ip

String

Details:

Server public IP address

Value Range

The value contains 0 to 128 characters.

private_ip

String

Details:

Server private IP address

Value Range

The value contains 0 to 2,048 characters.

asset_value

String

Details:

Asset importance. Its value can be:

Value Range

  • important: important asset

  • common: common asset

  • test: test asset

check_type

String

Details:

Name of the baseline check.

Value Range

The value contains 0 to 255 characters.

standard

String

Details:

Standard type. The options are as follows:

Value Range

  • cn_standard: DJCP MLPS compliance standard

  • hw_standard: Cloud security practice standard

  • cis_standard: general security standard

tag

String

Details:

Check type of check items in the baseline check.

Value Range

The value contains 0 to 128 characters.

check_rule_name

String

Details:

Name of check items in the baseline check.

Value Range

The value contains 0 to 2,048 characters.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_rule_num" : 3,
  "rule_num" : 2,
  "host_num" : 2,
  "data_list" : [ {
    "host_id" : "40371a5d-11df-30fc-80fb-a7b61715cd92",
    "host_name" : "DESKTOP-Q3H4UP1",
    "asset_value" : "common",
    "public_ip" : "10.122.112.21",
    "private_ip" : "192.168.10.5",
    "check_type" : "SSH",
    "standard" : "hw_standard",
    "tag" : "Access control",
    "check_rule_name" : "Rule: Restrict the access permission on **/etc/ssh/sshd_config**."
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

 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
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.*;


public class ListHandleAffectBaselineSolution {

    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();
        ListHandleAffectBaselineRequest request = new ListHandleAffectBaselineRequest();
        ListHandleAffectBaselineRequestBody body = new ListHandleAffectBaselineRequestBody();
        request.withBody(body);
        try {
            ListHandleAffectBaselineResponse response = client.listHandleAffectBaseline(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
# 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 = ListHandleAffectBaselineRequest()
        request.body = ListHandleAffectBaselineRequestBody(
        )
        response = client.list_handle_affect_baseline(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
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.ListHandleAffectBaselineRequest{}
	request.Body = &model.ListHandleAffectBaselineRequestBody{
	}
	response, err := client.ListHandleAffectBaseline(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

Request succeeded.

Error Codes

See Error Codes.