Displaying Server Vulnerability List

Function

This API is used to query the list of urgent or unfixed vulnerabilities.

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}/vulnerability/host-vulnerability/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.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
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.
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 CVE ID. Constraints N/A Range Length: 1 to 128 characters Default Value N/A
label_list	No	String	Definition Vulnerability tag. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
status	No	String	Definition Vulnerability status. Constraints N/A Range vul_status_unfix: not fixed vul_status_ignored: ignored vul_status_verified: verification in progress vul_status_fixing: fixing vul_status_fixed: fixed vul_status_reboot: fixed and pending restart vul_status_failed: fix failed vul_status_fix_after_reboot: Restart the server and try again. Default Value N/A
asset_value	No	String	Definition Server asset importance. Constraints N/A Range important common test Default Value N/A
group_name	No	String	Definition Server group that the server belongs to. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A
host_name	No	String	Definition Server name. Constraints N/A Range Length: 1 to 128 characters Default Value N/A
host_ip	No	String	Definition Server IP address. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
type	No	String	Definition Vulnerability type to be queried. Constraints N/A Range linux_vul: Linux vulnerabilities windows_vul: Windows vulnerabilities web_cms: Web-CMS vulnerabilities app_vul: application vulnerabilities urgent_vul: emergency vulnerabilities Default Value N/A
repair_type	No	String	Definition Query the severity of the vulnerability. Constraints N/A Range need_urgent_repair: vulnerabilities that need to be fixed urgently unrepair: vulnerabilities that have not been fixed Default Value N/A
severity_level	No	String	Definition Risk level. Constraints N/A Range Critical High Medium Low Default Value N/A
repair_priority	No	String	Definition Vulnerability fixing priority. Constraints N/A Range Critical High Medium Low Default Value N/A
host_id_list	No	String	Definition Server ID list. Use commas (,) to separate multiple server IDs. Constraints N/A Range The value can contain 0 to 1850 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
data_list	Array of data_list objects	array
total_num	Integer	Definition Total number. Range Minimum value: 0; maximum value: 100000000

**Table 5** data_list
Parameter	Type	Description
label_list	Array of strings	Definition Vulnerability tag list. Range Minimum value: 0; maximum value: 2147483647
repair_priority	String	Definition Fixing priority. Range Critical: critical High: high Medium: medium Low: low
repair_success_num	Integer	Definition Number of successful fixes of the current vulnerability. Range Minimum value: 0; maximum value: 1000000
vul_id	String	Definition Vulnerability ID. Range The value can contain 0 to 64 characters.
vul_name	String	Definition Vulnerability name. Range The value can contain 0 to 256 characters.
cve_list	Array of cve_list objects	Definition CVE list. Range Minimum value: 1; maximum value: 10000
is_affected_business	Boolean	Definition Whether services are affected. Range true: yes false: no
host_id	String	Definition Host ID. Range Length: 1 to 64 characters
public_ip	String	Definition Server EIP. Range Length: 0 to 128 characters
private_ip	String	Definition Server private IP address. Range Length: 0 to 128 characters
host_name	String	Definition Server name Range Length: 1 to 128 characters
asset_value	String	Definition Fixing priority. Range Critical: critical High: high Medium: medium Low: low
status	String	Definition Vulnerability status. Range Length: 0 to 32 characters
first_scan_time	Long	Definition First scan time. Range Minimum value: 0; maximum value: 9223372036854775807
scan_time	Long	Definition Last scan time. Range Minimum value: 0; maximum value: 9223372036854775807
disabled_operate_types	Array of disabled_operate_types objects	Definition List of operations that cannot be performed on a vulnerability. Range Minimum value: 1; maximum value: 10000

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

**Table 7** disabled_operate_types
Parameter	Type	Description
operate_type	String	Definition Operation type. Range ignore: ignore not_ignore: unignore immediate_repair: fix manual_repair: manual fix verify: verify add_to_whitelist: add to whitelist
reason	String	Definition Reason why an operation cannot be performed. Range The value can contain 0 to 512 characters.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "bcxxxxad-6xxb-4xx4-8xxc-9127xxxxxxd7",
    "host_name" : "ecs-30028218",
    "status" : "vul_status_unfix",
    "asset_value" : "common",
    "private_ip" : "192.168.0.1",
    "vul_name" : "[Security notice: UTSA-2023-001306] - [CVE-2023-2004]",
    "vul_id" : "UTSA-2023-001306",
    "repair_success_num" : 0,
    "cve_list" : [ {
      "cve_id" : "CVE-2023-2004"
    }, {
      "cvss" : 4.4
    } ],
    "scan_time" : 1761372857693,
    "first_scan_time" : 1760002721597,
    "is_affected_business" : true,
    "repair_priority" : "Low"
  } ]
}