Querying the Vulnerability Scan Tasks
Function
This API is used to query the vulnerability scan tasks.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/vulnerability/scan-tasks
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant project ID. Minimum: 1 Maximum: 256 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Default: 0 Minimum: 0 Maximum: 256 |
limit |
No |
Integer |
Number of records displayed on each page. Minimum: 0 Maximum: 200 Default: 10 |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. Minimum: 0 Maximum: 2000000 Default: 0 |
scan_type |
No |
String |
Type of a scan task. The options are as follows: -manual -schedule Minimum: 0 Maximum: 32 |
task_id |
No |
String |
Scan task ID. Minimum: 0 Maximum: 32 |
min_start_time |
No |
Long |
Minimum start time of a scan task. Minimum: 0 Maximum: 9999999999999 |
max_start_time |
No |
Long |
Maximum start time of a scan task. Minimum: 0 Maximum: 9999999999999 |
Request 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. Minimum: 1 Maximum: 32768 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Long |
Total number Minimum: 0 Maximum: 2147483647 |
data_list |
Array of VulScanTaskInfo objects |
Vulnerability scan tasks Array Length: 0 - 2147483647 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Task ID Minimum: 1 Maximum: 256 |
scan_type |
String |
Type of a scan task. The options are as follows: -manual -schedule Minimum: 0 Maximum: 128 |
start_time |
Long |
Start time of a scan task. Minimum: 0 Maximum: 2147483647 |
end_time |
Long |
End time of a scan task. Minimum: 0 Maximum: 2147483647 |
scan_vul_types |
Array of strings |
List of vulnerability types scanned by the task Minimum: 1 Maximum: 32 Array Length: 1 - 2147483647 |
status |
String |
Execution status of a scan task. The options are as follows: -running -finished Minimum: 1 Maximum: 32 |
scanning_host_num |
Integer |
Number of servers are being scanned Minimum: 0 Maximum: 2147483647 |
success_host_num |
Integer |
Number of servers have been successfully scanned Minimum: 0 Maximum: 2147483647 |
failed_host_num |
Integer |
Number of servers fail to be scanned Minimum: 0 Maximum: 2147483647 |
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
Vulnerability scan tasks
{ "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 } ] }
SDK Sample Code
The SDK sample code is as follows.
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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListVulScanTaskSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListVulScanTaskRequest request = new ListVulScanTaskRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withLimit(<limit>); request.withOffset(<offset>); request.withScanType("<scan_type>"); request.withTaskId("<task_id>"); request.withMinStartTime(<min_start_time>L); request.withMaxStartTime(<max_start_time>L); try { ListVulScanTaskResponse response = client.listVulScanTask(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListVulScanTaskRequest() request.enterprise_project_id = "<enterprise_project_id>" request.limit = <limit> request.offset = <offset> request.scan_type = "<scan_type>" request.task_id = "<task_id>" request.min_start_time = <min_start_time> request.max_start_time = <max_start_time> response = client.list_vul_scan_task(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListVulScanTaskRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest scanTypeRequest:= "<scan_type>" request.ScanType = &scanTypeRequest taskIdRequest:= "<task_id>" request.TaskId = &taskIdRequest minStartTimeRequest:= int64(<min_start_time>) request.MinStartTime = &minStartTimeRequest maxStartTimeRequest:= int64(<max_start_time>) request.MaxStartTime = &maxStartTimeRequest response, err := client.ListVulScanTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Vulnerability scan tasks |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot