Viewing the Vulnerabilities of All Types of Images

Function

This API is used to view the vulnerabilities of all image types.

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}/images/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	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 Vulnerability type. Constraints N/A Range linux_vul: Linux vulnerabilities app_vul: application vulnerabilities Default Value N/A
handle_status	Yes	String	Definition Vulnerability handling status. Constraints N/A Range unhandled handled Default Value N/A
image_type	Yes	String	Definition Image type. Constraints N/A Range local_image: local image registry: repository image cicd: CI/CD image cluster: cluster image Default Value N/A
severity_level	No	String	Definition Vulnerability risk level. Constraints N/A Range Critical High Medium Low Default Value N/A
vul_id	No	String	Definition Vulnerability ID. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
vul_name	No	String	Definition Vulnerability name. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
cve_id	No	String	Definition Vulnerability ID Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
label_list	No	Array of strings	Definition Vulnerability tag list. Range Minimum value: 0; maximum value: 10
status	No	String	Definition Vulnerability status. Constraints N/A Range vul_status_unfix: not fixed vul_status_ignored: ignored Default Value N/A
cluster_id	No	String	Definition Cluster ID. Constraints N/A Range The value can contain 0 to 128 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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total
data_list	Array of GeneralImageVulsResponseInfo objects	Vulnerability details

**Table 5** GeneralImageVulsResponseInfo
Parameter	Type	Description
vul_name	String	Definition Vulnerability name. Range The value can contain 0 to 128 characters.
vul_id	String	Definition Vulnerability ID. Range The value can contain 0 to 128 characters.
type	String	Definition Type Constraints N/A Range linux_vul: Linux vulnerabilities app_vul: application vulnerabilities Default Value N/A
image_type	String	Definition Image type. Constraints N/A Range local_image: local image registry: repository image cicd: CI/CD image cluster: cluster image Default Value N/A
label_list	Array of strings	Definition Vulnerability tag list. Range Minimum value:0; maximum value: 10
severity_level	String	Definition Vulnerability risk level. Constraints N/A Range Critical High Medium Low Default Value N/A
image_num	Integer	Definition Total number of affected images. Range The value can contain 0 to 2,147,483,547 characters.
cve_list	Array of cve_list objects	Definition CVE list. Range The value range is 0 to 10,000.
max_cvss_score	Float	Definition Maximum CVSS score of the image. Range The value can contain 0 to 10 characters.
scan_time	Long	Definition Latest scan time, in ms. Range The value can contain 0 to 4070880000000 characters.
description	String	Definition Vulnerability description. Range The value can contain 0 to 128 characters.
url	String	Definition Vulnerability fixing reference link. Range The value can contain 0 to 128 characters.
solution_detail	String	Definition Suggestion Range The value can contain 0 to 128 characters.
cluster_num	Integer	Definition Total number of affected clusters Range The value can contain 0 to 2,147,483,547 characters.

**Table 6** cve_list
Parameter	Type	Description
cve_id	String	Definition CVE ID Range Length: 1 to 32 characters
cvss	Float	Definition CVSS score. Range The value can contain 1 to 10 characters.

Example Requests

View the vulnerabilities of all image types

GET https://{endpoint}/v5/{project_id}/images/vulnerabilities?offset=0&limit=200&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "vul_name" : "CVE-2013-7397",
    "vul_id" : "HCVD-APP-CVE-2013-7397",
    "type" : "app_vul",
    "image_type" : "local",
    "label_list" : [ "Remote network attack." ],
    "severity_level" : {
      "severity_level" : "High",
      "image_num" : 1
    },
    "cve_list" : [ {
      "cvss" : 4.3,
      "cve_id" : "CVE-2013-7397"
    } ],
    "scan_time" : 1736476402048,
    "description" : "xxx",
    "url" : "https://bitbucket.org/asomov/snakeyaml/issues/377/allow-configuration-for-preventing-billion\\",
    "solution_detail" : "Formal rectification solution"
  } ]
}