Querying Details About Affected Servers - Software List

Function

This API is used to query details about the software list of affected servers.

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_id}/apps

**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
host_id	Yes	String	Definition Server ID. Constraints N/A Range Length: 1 to 128 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_id	No	String	Definition Vulnerability ID. Constraints N/A Range Length: 0 to 256 characters Default Value N/A
handle_status	No	String	Definition Vulnerability handling status. Constraints N/A Range handled unhandled Default Value N/A
container_id	No	String	Definition ID of the container where the vulnerability exists. Constraints N/A Range Length: 0 to 128 characters Default Value N/A
is_container	No	Boolean	Definition Whether the container scenario is involved. Constraints N/A Range true: container scenario false: non-container scenario 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	Definition Software information list Range N/A
total_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.

**Table 5** data_list
Parameter	Type	Description
app_name	String	Definition App name Range Length: 1 to 128 characters
path	String	Definition Path of the software that has vulnerabilities. This field is available only when you query vulnerabilities that have software paths, such as application vulnerabilities and emergency vulnerabilities. (Note: This field is about to be discarded. Use the paths field to obtain software path information.) Range Length: 1 to 512 characters
paths	Array of paths objects	Definition List of software paths that have vulnerabilities. This field is available only when you query vulnerabilities that have software paths, such as application vulnerabilities and emergency vulnerabilities. Range N/A
rule	String	Definition Vulnerability matching rule hit by software. Range Length: 1 to 512 characters

**Table 6** paths
Parameter	Type	Description
app_path	String	Definition Path of the software that has vulnerabilities. Range Length: 1 to 512 characters
app_version	String	Definition Software version Range Length: 1 to 64 characters
status	String	Definition Vulnerability status. Range vul_status_unfix: not handled 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.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "app_name" : "mysql",
    "path" : "/usr/sbin",
    "paths" : [ {
      "app_path" : "/usr/sbin",
      "app_version" : "5.7.22",
      "status" : "vul_status_unfix"
    } ],
    "rule" : "Your mysql version has this vulnerability. Current version: 5.7.22 Versions with this vulnerability: (5.7.0,5.7.24)"
  } ]
}