Help Center/ Host Security Service/ API Reference/ API Description/ Baseline Management/ Querying the Baseline Whitelist
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying the Baseline Whitelist

Function

This API is used to query the baseline whitelist.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/baseline/whitelists

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

check_rule_name

No

String

This API is used to query the name of baseline check items.

os_type

No

String

OSs that support baseline check

  • Linux

  • Windows

rule_type

No

String

Rule scope of the baseline check whitelist.

  • specific_host

  • all_host

tag

No

String

Check type of items in the baseline check.

  • Access control

  • Service configuration

description

No

String

Remarks of the baseline check whitelist

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number of baseline whitelists

data_list

Array of BaselineWhiteListsResponseInfo objects

Baseline whitelist

tag_list

Array of strings

Check types of check items in the baseline check
Table 5 BaselineWhiteListsResponseInfo

Parameter

Type

Description

id

String

Baseline Whitelist ID

rule_type

String

Rule scope of the baseline check whitelist.

  • specific_host

  • all_host

os_type

String

Operating system for baseline check

  • Linux

  • Windows

index_version

String

ID of the baseline check item.

check_type

String

Name of the baseline to be checked.

standard

String

Standard type. Its value can be:

  • cn_standard: DJCP MLPS compliance standard

  • hw_standard: Cloud security practice standard

  • cis_standard: common security standard

tag

String

Check type of the check item in the baseline check.

  • Access control

  • Service configuration

check_rule_name

String

Name of the check item in the baseline check.

description

String

Baseline whitelist remarks

Example Requests

Query the baseline whitelist of an enterprise project (project ID: xxx)

GET https://{endpoint}/v5/{project_id}/baseline/whitelists?enterprise_project_id=xxx&limit=100&offset=0

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 2,
  "data_list" : [ {
    "id" : "00bd5209-d8df-43af-bf91-5c0cfc965a1a",
    "rule_type" : "specific_host",
    "os_type" : "Linux",
    "index_version" : "4.1",
    "check_type" : "HCE1.1",
    "standard" : "cn_standard",
    "tag" : "Access control",
    "check_rule_name" : "Rule: Access control A",
    "description" : "Baseline whitelist A"
  }, {
    "id" : "01e7a09c-99ff-4418-b960-6b198e814c72",
    "rule_type" : "all_host",
    "os_type" : "windows",
    "index_version" : "4.2",
    "check_type" : "windows2012",
    "standard" : "cn_standard",
    "tag" : "Service Configuration",
    "check_rule_name" : "Rule: Service configuration B",
    "description" : "Baseline whitelist A"
  } ],
  "tag_list" : [ "Access control", "Service Configuration" ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Baseline Management