Retrieving User Vulnerability Data

Function

This API is used to query user vulnerability 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}/image/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
repair_necessity	No	String	Definition Repair urgency. Range immediate_repair: The fault must be rectified as soon as possible. delay_repair: The problem can be fixed later. not_needed_repair: The problem does not need to be fixed. Constraints N/A Default Value N/A
vul_id	No	String	Definition Vulnerability ID (fuzzy search supported) Constraints N/A Range The value can contain 0 to 65,535 characters. Default Value N/A
type	No	String	Definition Type Constraints N/A Range linux_vul: Linux vulnerabilities app_vul: application vulnerabilities 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
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number of vulnerabilities. Range Value range: 0 to 65,535
data_list	Array of GlobalVulInfo objects	Definition Record of a vulnerability.

**Table 5** GlobalVulInfo
Parameter	Type	Description
vul_name	String	Vulnerability
vul_id	String	Definition Vulnerability ID. Range The value can contain 0 to 65,535 characters.
repair_necessity	String	Definition Repair urgency. Range immediate_repair: The problem must be rectified as soon as possible. delay_repair: The problem can be fixed later. not_needed_repair: The problem does not need to be fixed.
decription	String	Definition Vulnerability description. Range The value can contain 0 to 65,535 characters.
solution	String	Definition Solution. Range The value can contain 0 to 65,535 characters.
url	String	Definition URL. Range The value can contain 0 to 65,535 characters.
history_number	Integer	Definition Number of historically affected images. Range Value range: 0 to 65,535
undeal_number	Integer	Definition Format of an unhandled image. Range Value range: 0 to 65,535
data_list	Array of CveInfo objects	CVE list

**Table 6** CveInfo
Parameter	Type	Description
cve_id	String	Definition CVE id Range The value can contain 0 to 128 characters.
cvss_score	Float	Definition CVSS score. Range The value range is 0 to 100.
publish_time	Long	Definition CVE release time, in ms. Range The value range is 0 to 3,857,960,855,552.
description	String	Definition CVE description. Range The value can contain 0 to 256 characters.

Example Requests

Query user vulnerability information

GET https://{endpoint}/v5/{project_id}/image/vulnerabilities?enterprise_project_id=all_granted_ep

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 16,
  "data_list" : [ {
    "vul_name" : "vul_name",
    "vul_id" : "vul_id",
    "repair_necessity" : "immediate_repair",
    "data_list" : [ {
      "cve_id" : "cve_id"
    } ]
  } ]
}