Estimating Vulnerability Scan Durations

This API is used to query the estimated vulnerability scan time.

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.

POST /v5/{project_id}/vulnerability/scan/task/estimated-time

**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.

**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

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
manual_scan_type	No	Array of strings	Definition Manual vulnerability detection type. 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
range_type	No	String	Definition Server range to be checked Constraints N/A Range all_host specific_host Default Value N/A
agent_ids	No	Array of strings	Definition List of agents to be checked. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
queue_time	Long	Definition Waiting time for vulnerability scan, in minutes. Constraints N/A Range The value can contain 1 to 9223372036854775807 characters. Default Value N/A
run_time	Long	Definition Time required for executing the task, in minutes. Constraints N/A Range The value can contain 1 to 9223372036854775807 characters. Default Value N/A
total_time	Integer	Definition Total duration from the current time to the time when the task ends, in minutes. Constraints N/A Range The value can contain 1 to 9223372036854775807 characters. Default Value N/A

None

Status code: 200

Request succeeded.

{
  "queue_time" : 765930242984,
  "run_time" : 765930242984,
  "total_time" : 765930242984
}

Status Code	Description
200	Request succeeded.

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.