Updated on 2026-02-05 GMT+08:00

Querying the Check Item List

Function

This API is used to query the check item list.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/workspaces/{workspace_id}/sa/baseline/checkitems/search

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

content-type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A

X-Language

Yes

String

Definition

Language. Reference value: zh-cn or en-us.

Constraints

N/A

Range

zh-cn: Chinese environment

en-us: English environment

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

catalog_uuid

No

String

Directory ID of the check item.

compliance_package_id

No

String

Compliance pack ID of the check item.

limit

No

Integer

Page size.

offset

No

Integer

Offset. The records after this offset will be queried.

sort_by

No

String

Sorting keyword.

order

No

String

Descending or ascending order.

DESC: descending order

ASC: ascending order

name

No

String

Filter by check item name.

suggestion

No

String

Filter by check item suggestion.

type

No

Integer

Check item type.

0: built-in

1: custom

source_list

No

Array of integers

Filter by check item execution method. 0: Kotlin; 2: playbook workflow; 3: manual; 4: host access

condition

No

condition object

Search condition expression.

query_mode

No

String

Filter field.

severity

No

String

Filter by check item severity.

  • Fatal: fatal

  • High: high-risk

  • Medium: medium-risk

  • Low: low-risk

  • Tips: Tips

Table 4 condition

Parameter

Mandatory

Type

Description

conditions

No

Array of conditions objects

Expression list.

logics

No

Array of strings

Expression name list.

Table 5 conditions

Parameter

Mandatory

Type

Description

name

No

String

Expression name.

data

No

Array of strings

Expression content list.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

builtin_checkitem_num

Number

Number of built-in check items.

checkitem_num

Number

Total number of check items.

customized_checkitem_num

Number

Number of custom check items.

count

Number

Total number of check items.

checkitems

Array of CheckitemModel objects

Check item details.

Table 7 CheckitemModel

Parameter

Type

Description

uuid

String

Check item ID.

aggregation_handle_status

String

Check item result aggregation status.

audit_procedure

String

Check process of the check item.

impact

String

Impact of the check item.

cloud_server

String

Cloud service to which the check item belongs.

description

String

Check item description.

level

String

Check item severity.

informational: informational

low: low risk

medium: medium risk

high: high risk

fatal: fatal

method

Integer

Check method of the check item.

0: automatic

3: playbook workflows.

name

String

Check item name.

source

Integer

Source of the check item.

0: default

2: workflows and playbooks

workflow_id

String

Definition

Workflow ID.

Constraints

N/A

spec_checkitem_list

Array of SpecCheckitemModel objects

Information about the compliance pack to which the check item belongs.

Table 8 SpecCheckitemModel

Parameter

Type

Description

checkitem_uuid

String

Check item UUID.

create_time

String

Compliance pack creation timestamp.

language

String

Compliance pack language environment.

name

String

Compliance pack name.

remove_time

String

Compliance pack deletion timestamp.

specification_uuid

String

Compliance pack UUID.

uuid

String

uuid

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Status code: 401

Table 10 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

Query built-in check items with pagination (first page, 10 data records per page).

https://{endpoint}/v2/{project_id}/workspaces/{workspace_id}/sa/baseline/checkitems/search

{
  "limit" : 10,
  "offset" : 0,
  "type" : 0
}

Example Responses

Status code: 200

Request succeeded.

{
  "builtin_checkitem_num" : 10,
  "checkitem_num" : 10,
  "customized_checkitem_num" : 10,
  "count" : 10,
  "checkitems" : [ {
    "uuid" : "string",
    "aggregation_handle_status" : "string",
    "audit_procedure" : "string",
    "impact" : "string",
    "cloud_server" : "cloudservices",
    "description" : "test checkitem",
    "level" : "medium",
    "method" : 0,
    "name" : "test checkitem",
    "source" : 2,
    "workflow_id" : "stringstringstringstringstringst",
    "spec_checkitem_list" : [ {
      "checkitem_uuid" : "string",
      "create_time" : "string",
      "language" : "string",
      "name" : "string",
      "remove_time" : "string",
      "specification_uuid" : "string",
      "uuid" : "string"
    } ]
  } ]
}

Status code: 400

Request failed.

{
  "error_code" : "SecMaster.00040006",
  "error_msg" : "Invalid request parameters"
}

Status code: 401

Insufficient permission.

{
  "error_code" : "SecMaster.90010015",
  "error_msg" : "Unauthorized request"
}

Status code: 500

Request failed.

{
  "error_code" : "SecMaster.00040011",
  "error_msg" : "Internal system error"
}

SDK Sample Code

The SDK sample code is as follows.

Query built-in check items with pagination (first page, 10 data records per page).

 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
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.secmaster.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;


public class SearchCheckitemsSolution {

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

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        SearchCheckitemsRequest request = new SearchCheckitemsRequest();
        request.withWorkspaceId("{workspace_id}");
        SearchCheckitemsRequestBody body = new SearchCheckitemsRequestBody();
        body.withType(0);
        body.withOffset(0);
        body.withLimit(10);
        request.withBody(body);
        try {
            SearchCheckitemsResponse response = client.searchCheckitems(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());
        }
    }
}

Query built-in check items with pagination (first page, 10 data records per page).

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v2 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 = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = SearchCheckitemsRequest()
        request.workspace_id = "{workspace_id}"
        request.body = SearchCheckitemsRequestBody(
            type=0,
            offset=0,
            limit=10
        )
        response = client.search_checkitems(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Query built-in check items with pagination (first page, 10 data records per page).

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/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 := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.SearchCheckitemsRequest{}
	request.WorkspaceId = "{workspace_id}"
	typeSearchCheckitemsRequestBody:= int32(0)
	offsetSearchCheckitemsRequestBody:= int32(0)
	limitSearchCheckitemsRequestBody:= int32(10)
	request.Body = &model.SearchCheckitemsRequestBody{
		Type: &typeSearchCheckitemsRequestBody,
		Offset: &offsetSearchCheckitemsRequestBody,
		Limit: &limitSearchCheckitemsRequestBody,
	}
	response, err := client.SearchCheckitems(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.

400

Request failed.

401

Insufficient permission.

500

Request failed.

Error Codes

See Error Codes.