Help Center/ Host Security Service/ API Reference/ API Description/ Container Images/ Querying the List of Vulnerabilities Affected by Image Vulnerability Handling Operations
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying the List of Vulnerabilities Affected by Image Vulnerability Handling Operations

Function

This API is used to query the list of vulnerabilities affected by image vulnerability handling operations.

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

POST /v5/{project_id}/image/vulnerability/handle-affect-vulnerabilities

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

image_name

No

String

Definition

Image name.

Constraints

N/A

Range

Length: 0 to 512 characters

Default Value

N/A

vul_name

No

String

Definition

Vulnerability name.

Constraints

N/A

Range

Length: 0 to 512 characters

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
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

image_type

Yes

String

Definition

Image type.

Constraints

N/A

Range

  • local: local image

  • registry: repository image

  • **cicd **: CI/CD image

Default Value

N/A

type

Yes

String

Definition

Vulnerability type.

Constraints

N/A

Range

  • linux_vul: Linux vulnerability

  • app_vul: application vulnerability

Default Value

N/A

operate_type

Yes

String

Definition

Actions taken to handle the vulnerability

Constraints

N/A

Range

  • ignore: ignore

  • not_ignore: unignore

  • manual_repair: manual fix

  • add_to_whitelist: whitelist

Default Value

N/A

handle_status

No

String

Definition

Status of vulnerabilities to be handled

Constraints

N/A

Range

  • unhandled: vulnerability to be handled

  • handled: handled vulnerabilities

Default Value

N/A

select_type

Yes

String

Definition

Type of vulnerability handling scope

Constraints

N/A

Range

  • all_vul: Handle all vulnerabilities.

  • specific_image_all_vul: Handle all the vulnerabilities of a specified image.

  • specific_vul_all_image:: Handle all the images of a specified vulnerability.

  • vul_view: Specify the vulnerabilities and images to be handled in the vulnerability dimension.

  • image_view: Specify the vulnerabilities and images to be handled in the image dimension.

Default Value

N/A

image_id_list

No

Array of strings

Definition

If select_type is set to specific_image_all_vul, this field specifies the ID list of images to be handled.

Constraints

This field is valid only when select_type is set to specific_image_all_vul.

Range

N/A

Default Value

N/A

vul_id_list

No

Array of strings

Definition

ID list of vulnerabilities to be handled when select_type is set to specific_vul_all_image.

Constraints

This field is valid only when select_type is set to specific_vul_all_image.

Range

N/A

Default Value

N/A

vul_data_list

No

Array of vul_data_list objects

Definition

When select_type is set to vul_view, this parameter specifies the vulnerabilities and images to be handled.

Constraints

This field is valid only when select_type is set to vul_view.

Range

N/A

Default Value

N/A

image_data_list

No

Array of image_data_list objects

Definition

When select_type is set to image_view, this parameter specifies the vulnerabilities and images to be handled.

Constraints

This parameter is valid only when select_type is set to image_view.

Range

N/A

Default Value

N/A

remark

No

String

Definition

Description of the handling operation.

Constraints

N/A

Range

Length: 0 to 512 characters

Default Value

N/A
Table 5 vul_data_list

Parameter

Mandatory

Type

Description

vul_id

No

String

Definition

Vulnerability ID.

Constraints

N/A

Range

Length: 0 to 128 characters

Default Value

N/A

image_id_list

No

Array of strings

Definition

List of image IDs.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 6 image_data_list

Parameter

Mandatory

Type

Description

image_id

No

String

Definition

Image ID.

Constraints

N/A

Range

Length: 0 to 512 characters

Default Value

N/A

vul_id_list

No

Array of strings

Definition

Vulnerability ID list.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

total_vul_num

Integer

Definition

Total number of vulnerabilities in images.

Range

Minimum value: 0; maximum value: 2147483547

vul_num

Integer

Definition

Number of vulnerabilities

Range

Minimum value: 0; maximum value: 2147483547

image_num

Integer

Definition

Number of images

Range

Minimum value: 0; maximum value: 2147483547

data_list

Array of ImageVulResponseInfo objects

Definition

Image vulnerability list

Range

Minimum value: 0; maximum value: 5000
Table 8 ImageVulResponseInfo

Parameter

Type

Description

image_id

String

Definition

Image ID.

Range

Length: 0 to 512 characters

image_name

String

Definition

Image name.

Range

Length: 0 to 512 characters

vul_id

String

Definition

Vulnerability ID.

Range

Length: 0 to 512 characters

vul_name

String

Definition

Vulnerability name.

Range

Length: 0 to 512 characters

Example Requests

Querying the List of Vulnerabilities Affected by Image Vulnerability Handling Operations

POST https://{endpoint}/v5/{project_id}/image/vulnerability/handle-affect-vulnerabilities?limit=10&offset=0

{
  "image_type" : "local",
  "type" : "linux_vul"
}

Example Responses

Status code: 200

Request succeeded.

{
  "total_vul_num" : 2,
  "vul_num" : 2,
  "image_num" : 1,
  "data_list" : [ {
    "image_id" : "b1ae2e05-e367-4c03-acb7-b3911fd4441b",
    "image_name" : "mysql/mysql-server",
    "vul_id" : "HCVD-APP-CVE-2023-22005",
    "vul_name" : "CVE-2023-22005"
  }, {
    "image_id" : "b1ae2e05-e367-4c03-acb7-b3911fd4441b",
    "image_name" : "mysql/mysql-server",
    "vul_id" : "HCVD-APP-CVE-2023-22008",
    "vul_name" : "CVE-2023-22008"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Images