Querying the Vulnerability Scan Tasks

Function

This API is used to query the vulnerability scan tasks.

URI

GET /v5/{project_id}/vulnerability/scan-tasks

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Table 2 Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.
limit	No	Integer	Number of records displayed on each page.
offset	No	Integer	Offset, which specifies the start position of the record to be returned.
scan_type	No	String	Type of a scan task. The options are as follows: -manual -schedule
task_id	No	String	Scan task ID.
min_start_time	No	Long	Minimum start time of a scan task.
max_start_time	No	Long	Maximum start time of a scan task.

Request Parameters

Table 3 Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters
Parameter	Type	Description
total_num	Long	Total number
data_list	Array of VulScanTaskInfo objects	Vulnerability scan tasks

Table 5 VulScanTaskInfo
Parameter	Type	Description
id	String	Task ID
scan_type	String	Type of a scan task. The options are as follows: -manual -schedule
start_time	Long	Start time of a scan task.
end_time	Long	End time of a scan task.
scan_vul_types	Array of strings	List of vulnerability types scanned by the task
status	String	Execution status of a scan task. The options are as follows: -running -finished
scanning_host_num	Integer	Number of servers are being scanned
success_host_num	Integer	Number of servers have been successfully scanned
failed_host_num	Integer	Number of servers fail to be scanned

Example Requests

Query information about the vulnerability scan task whose type is manual scan and task_id is 195db604-2008-4e8b-a49e-389ab0175beb. By default, 10 records on the first page are queried.

GET https://{endpoint}/v5/{project_id}/vulnerability/scan-tasks?offset=0&limit=10&enterprise_project_id=XXX

{
  "scan_type" : "manual",
  "task_id" : "195db604-2008-4e8b-a49e-389ab0175beb"
}

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 10,
  "data_list" : [ {
    "id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
    "scan_type" : "manual",
    "start_time" : 1679042408195,
    "end_time" : 1679042408295,
    "scan_vul_types" : [ "linux_vul" ],
    "status" : "running",
    "scanning_host_num" : 1,
    "success_host_num" : 1,
    "failed_host_num" : 1
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent topic: Vulnerability Management

Предыдущая статья

Modifying a Vulnerability Scan Policy

Следующая статья

Querying the List of Servers Corresponding to a Vulnerability Scan Task

Была ли эта статья полезна?

Поддержка Юридические документы