Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Actualización más reciente 2025-04-08 GMT+08:00

Consulta de las tareas de escaneo de vulnerabilidades

Función

Esta API se utiliza para consultar las tareas de escaneo de vulnerabilidades.

Método de invocación

Para obtener más información, consulte Invocación a las API.

URI

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

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

String

ID del proyecto del tenant.

Mínimo: 1

Máximo: 256

Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

enterprise_project_id

No

String

ID de proyecto empresarial. Para consultar todos los proyectos empresariales, establezca este parámetro en all_granted_eps.

Valor predeterminado: 0

Mínimo: 0

Máximo: 256

limit

No

Integer

Número de registros mostrados en cada página.

Mínimo: 0

Máximo: 200

Valor predeterminado: 10

offset

No

Integer

Desfase, que especifica la posición inicial del registro que se va a devolver. El valor debe ser un número no menor que 0. El valor predeterminado es 0.

Mínimo: 0

Máximo: 2000000

Valor predeterminado: 0

scan_type

No

String

Tipo de tarea de escaneo. Las opciones son las siguientes: -manual -schedule

Mínimo: 0

Máximo: 32

task_id

No

String

ID de tarea de análisis.

Mínimo: 0

Máximo: 32

min_start_time

No

Long

Hora mínima de inicio de una tarea de escaneo.

Mínimo: 0

Máximo: 9999999999999

max_start_time

No

Long

Tiempo máximo de inicio de una tarea de análisis.

Mínimo: 0

Máximo: 9999999999999

Parámetros de solicitud

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

String

Token de usuario. Se puede obtener mediante invocación a una API de IAM. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario.

Mínimo: 1

Máximo: 32768

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

total_num

Long

Número total

Mínimo: 0

Máximo: 2147483647

data_list

Array of VulScanTaskInfo objects

Tareas de escaneo de vulnerabilidades

Longitud de matriz: 0 - 2147483647

Tabla 5 VulScanTaskInfo

Parámetro

Tipo

Descripción

id

String

ID de tarea

Mínimo: 1

Máximo: 256

scan_type

String

Tipo de tarea de escaneo. Las opciones son las siguientes: -manual -schedule

Mínimo: 0

Máximo: 128

start_time

Long

Hora de inicio de una tarea de escaneo

Mínimo: 0

Máximo: 2147483647

end_time

Long

Hora de finalización de una tarea de escaneo

Mínimo: 0

Máximo: 2147483647

scan_vul_types

Array of strings

Lista de tipos de vulnerabilidad escaneados por la tarea

Mínimo: 1

Máximo: 32

Longitud de matriz: 1 - 2147483647

status

String

Estado de ejecución de una tarea de escaneo. Las opciones son las siguientes: -running -finished

Mínimo: 1

Máximo: 32

scanning_host_num

Integer

Número de servidores que se están escaneando

Mínimo: 0

Máximo: 2147483647

success_host_num

Integer

El número de servidores se ha escaneado correctamente

Mínimo: 0

Máximo: 2147483647

failed_host_num

Integer

Número de servidores que no se pudieron escanear

Mínimo: 0

Máximo: 2147483647

Solicitudes de ejemplo

Consultar información sobre la tarea de escaneo de vulnerabilidades cuyo tipo es escaneo manual y task_id es 195db604-2008-4e8b-a49e-389ab0175beb. Por defecto, se consultan 10 registros de la primera página.

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"
}

Ejemplo de respuestas

Código de estado: 200

Tareas de escaneo de vulnerabilidades

{
  "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
  } ]
}

Código de ejemplo del SDK

El código de ejemplo del SDK es el siguiente.

Java

Consultar información sobre la tarea de escaneo de vulnerabilidades cuyo tipo es escaneo manual y task_id es 195db604-2008-4e8b-a49e-389ab0175beb. Por defecto, se consultan 10 registros de la primera página.

 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());
        }
    }
}

Python

Consultar información sobre la tarea de escaneo de vulnerabilidades cuyo tipo es escaneo manual y task_id es 195db604-2008-4e8b-a49e-389ab0175beb. Por defecto, se consultan 10 registros de la primera página.

 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)

Go

Consultar información sobre la tarea de escaneo de vulnerabilidades cuyo tipo es escaneo manual y task_id es 195db604-2008-4e8b-a49e-389ab0175beb. Por defecto, se consultan 10 registros de la primera página.

 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)
    }
}

Más información

Para obtener un código de ejemplo del SDK de más lenguajes de programación, consulte la pestaña Código de ejemplo en API Explorer. El código de ejemplo del SDK se puede generar automáticamente.

Códigos de estado

Código de estado

Descripción

200

Tareas de escaneo de vulnerabilidades

Códigos de error

Consulte Códigos de error.