Help Center/ Host Security Service/ API Reference/ API Description/ Container Images/ Obtaining Baseline Check Configuration Information
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Obtaining Baseline Check Configuration Information

Function

This API is used to obtain baseline check configuration information.

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/check-rules

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

No

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

The default value is 0.

limit

No

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10-200

Default Value

10

type

Yes

String

Definition

Type.

Constraints

N/A

Range

  • image: image

Default Value

N/A

image_type

Yes

String

Definition

Image type.

Constraints

N/A

Range

  • **cicd **: CI/CD image

  • registry: repository image

Default Value

N/A

namespace

No

String

Definition

Organization name.

Constraints

N/A

Range

The string can contain 0 to 65535 characters.

Default Value

N/A

image_name

No

String

Definition

Image name.

Constraints

N/A

Range

The string can contain 0 to 65535 characters.

Default Value

N/A

image_version

No

String

Definition

Image tag name.

Constraints

N/A

Range

The string can contain 0 to 65535 characters.

Default Value

N/A

instance_id

No

String

Definition

Enterprise repository instance ID. This API is not required for the SWR shared edition.

Constraints

N/A

Range

The string can contain 0 to 128 characters.

Default Value

N/A

image_id

No

String

Definition

Image ID.

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

scan_result

No

String

Definition

Check result.

Constraints

N/A

Range

  • pass

  • failed

Default Value

N/A

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

Definition

Total number.

Range

Minimum value: 0; maximum value: 2,147,483,547

data_list

Array of ImageCheckRuleResponseInfo objects

Definition

Image configuration check information.

Range

The value range is 0 to 10,241.
Table 5 ImageCheckRuleResponseInfo

Parameter

Type

Description

severity

String

Definition

Severity

Range

  • Security

  • Low

  • Medium

  • High

check_name

String

Definition

Baseline name

Range

The value contains 0 to 256 characters.

check_type

String

Definition

Baseline type

Range

The value contains 0 to 256 characters.

standard

String

Definition

Standard type.

Range

  • cn_standard: DJCP MLPS compliance standard

  • hw_standard: Huawei standard

  • qt_standard: Qingteng standard

check_type_desc

String

Definition

Baseline description

Range

The value contains 0 to 65,534 characters.

check_rule_name

String

Definition

Check items

Range

The value contains 0 to 2,048 characters.

check_rule_id

String

Definition

Check Item ID

Range

The value contains 0 to 128 characters.

scan_result

String

Definition

Detection result

Range

  • pass

  • failed

latest_scan_time

Long

Definition

Last detection time, in ms.

Range

0 to 9223372036854775807

image_num

Integer

Definition

Number of affected images, that is, the number of images for which the current baseline detection is performed

Range

0 to 2097152

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "check_name" : "xxx",
    "check_type" : "xxx",
    "standard" : "hw_standard",
    "check_type_desc" : "xxx",
    "check_rule_name" : "xxx",
    "check_rule_id" : "xxx",
    "scan_result" : "pass",
    "latest_scan_time" : 253,
    "severity" : "high",
    "image_num" : 11
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Images