Help Center/ SecMaster/ API Reference/ Security Analysis V2 APIs/ Baseline Inspection/ Querying the Compliance Pack List
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Compliance Pack List

Function

This API is used to query the compliance pack list.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/workspaces/{workspace_id}/sa/baseline/compliance-packages/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

limit

Yes

Integer

Page size.

offset

Yes

Integer

Offset.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Total compliance packs.

compliance_packages

Array of CompliancePackageModel objects

Compliance pack list.
Table 5 CompliancePackageModel

Parameter

Type

Description

uuid

String

Compliance pack UUID.

name

String

Compliance pack name.

version

String

Compliance pack version.

owner

String

Compliance pack owner.

spec_catalog_vo_list

Array of BaselineCatalogModel objects

Compliance pack directory list.

description

String

Description of the compliance pack.

classify

String

Compliance pack category.

areas

String

Applicable domain of the compliance pack.

region

String

Region where the compliance pack applies.
Table 6 BaselineCatalogModel

Parameter

Type

Description

uuid

String

Unique ID (UUID) of a directory.

serial_number

Integer

Directory location sequence.

level_number

Integer

Directory hierarchy.

root

String

UUID of the compliance pack where the directory is located.

parent

String

UUID of the parent directory of the directory. If the directory is at the first layer, the value is the UUID of the compliance pack.

is_leaf

Integer

Whether the directory is a leaf node.

0: No

1: Yes

check_items

Array of CheckitemCatalogModel objects

Check items associated with the directory.
Table 7 CheckitemCatalogModel

Parameter

Type

Description

uuid

String

Check item UUID.

name

String

Check item name.

Status code: 400

Table 8 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 compliance packs with pagination (first page, 10 records per page).

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

Example Responses

None

Status Codes

Status Code

Description

200

Response body for querying the compliance pack list.

400

Error response body for querying the compliance pack list.

Error Codes

See Error Codes.

Parent topic: Baseline Inspection