查询漏洞扫描任务列表
功能介绍
查询漏洞扫描任务列表
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/vulnerability/scan-tasks
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
租户企业项目ID,查询所有企业项目时填写:all_granted_eps |
limit |
否 |
Integer |
每页显示个数 |
offset |
否 |
Integer |
偏移量:指定返回记录的开始位置 |
scan_type |
否 |
String |
扫描任务的类型,包含如下: -manual : 手动扫描任务 -schedule : 定时扫描任务 |
task_id |
否 |
String |
扫描任务ID |
min_start_time |
否 |
Long |
扫描任务开始时间的最小值 |
max_start_time |
否 |
Long |
扫描任务开始时间的最大值 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Long |
总数 |
data_list |
Array of VulScanTaskInfo objects |
漏洞扫描任务列表 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
任务ID |
scan_type |
String |
扫描任务的类型,包含如下: -manual : 手动扫描任务 -schedule : 定时扫描任务 |
start_time |
Long |
扫描任务开始的时间 |
end_time |
Long |
扫描任务结束的时间 |
scan_vul_types |
Array of strings |
该任务扫描的漏洞类型列表 |
status |
String |
扫描任务的执行状态,包含如下: -running : 扫描中 -finished : 扫描完成 |
scanning_host_num |
Integer |
该任务处于扫描中状态的主机数量 |
success_host_num |
Integer |
该任务已扫描成功的主机数量 |
failed_host_num |
Integer |
该任务已扫描失败的主机数量 |
请求示例
查询任务类型为手动扫描,task_id为195db604-2008-4e8b-a49e-389ab0175beb漏洞扫描任务信息,默认查询第一页10条
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" }
响应示例
状态码: 200
漏洞扫描任务列表
{ "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代码示例
SDK代码示例如下。
查询任务类型为手动扫描,task_id为195db604-2008-4e8b-a49e-389ab0175beb漏洞扫描任务信息,默认查询第一页10条
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 |
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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListVulScanTaskRequest request = new ListVulScanTaskRequest(); 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()); } } } |
查询任务类型为手动扫描,task_id为195db604-2008-4e8b-a49e-389ab0175beb漏洞扫描任务信息,默认查询第一页10条
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 |
# coding: utf-8 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListVulScanTaskRequest() 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) |
查询任务类型为手动扫描,task_id为195db604-2008-4e8b-a49e-389ab0175beb漏洞扫描任务信息,默认查询第一页10条
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 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListVulScanTaskRequest{} response, err := client.ListVulScanTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
漏洞扫描任务列表 |
错误码
请参见错误码。