Help Center/ Host Security Service/ API Reference/ API Description/ Container Images/ Listing Resources Affected by a Configuration Check Item
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Listing Resources Affected by a Configuration Check Item

Function

This API is used to list resources affected by a configuration check item.

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-rule/resources

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

check_rule_id

Yes

String

Definition

Check Item ID.

Constraints

N/A

Range

The value can contain 0 to 256 characters.

Default Value

N/A

check_name

Yes

String

Definition

Configuration check baseline name, for example, SSH, CentOS 7, or Windows.

Constraints

N/A

Range

The value can contain 0 to 256 characters.

Default Value

N/A

standard

Yes

String

Definition

Standard type.

Constraints

N/A

Range

  • cn_standard: DJCP MLPS compliance standard

  • hw_standard: Cloud security practice standard

Default Value

N/A

scan_result

No

String

Definition

Check result.

Constraints

N/A

Range

  • pass: passed

  • failed: 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

Total amount of image data affected by configuration detection

data_list

Array of CheckRuleImageResponseInfo objects

Data list
Table 5 CheckRuleImageResponseInfo

Parameter

Type

Description

namespace

String

Definition

Organization name

Range

The value contains 0 to 64 characters.

image_digest

String

Definition

Image digest.

Range

The value contains 0 to 128 characters.

image_name

String

Definition

Image name

Range

The value contains 0 to 128 characters.

image_version

String

Definition

Image version

Range

The value contains 0 to 128 characters.

image_type

String

Definition

Image type

Range

  • private_image

  • shared_image

  • instance_image (enterprise image)

  • harbor

  • jfrog

  • cicd

registry_name

String

Definition

Image repository name.

Range

The value contains 0 to 128 characters.

image_size

Integer

Definition

Version size.

Range

Size: 0-2147483547

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "namespace" : "xxx",
    "image_digest" : "xxx",
    "image_name" : "xxx",
    "image_version" : "xxx",
    "image_type" : "private_image",
    "registry_name" : "xxx",
    "image_size" : 111
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Images