Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Atualizado em 2024-09-14 GMT+08:00

Consulta das tarefas de verificação de vulnerabilidades

Função

Essa API é usada para consultar as tarefas de verificação de vulnerabilidades.

Método de chamada

Para obter detalhes, consulte Chamada de APIs.

URI

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

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto do locatário.

Mínimo: 1

Máximo: 256

Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

enterprise_project_id

Não

String

ID do projeto empresarial. Para consultar todos os projetos empresariais, defina este parâmetro como all_granted_eps.

Padrão: 0

Mínimo: 0

Máximo: 256

limit

Não

Integer

Número de registros exibidos em cada página.

Mínimo: 0

Máximo: 200

Padrão: 10

offset

Não

Integer

Deslocamento, que especifica a posição inicial do registro a ser retornado. O valor deve ser um número não menor que 0. O valor padrão é 0.

Mínimo: 0

Máximo: 2000000

Padrão: 0

scan_type

Não

String

Tipo de uma tarefa de verificação. As opções são as seguintes: -manual -schedule

Mínimo: 0

Máximo: 32

task_id

Não

String

ID da tarefa de verificação.

Mínimo: 0

Máximo: 32

min_start_time

Não

Long

Hora mínima de início de uma tarefa de verificação.

Mínimo: 0

Máximo: 9999999999999

max_start_time

Não

Long

Hora máxima de início de uma tarefa de verificação.

Mínimo: 0

Máximo: 9999999999999

Parâmetros de solicitação

Tabela 3 Parâmetros de cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Token do usuário. Ele pode ser obtido chamando uma API do IAM. O valor de X-Subject-Token no cabeçalho de resposta é o token do usuário.

Mínimo: 1

Máximo: 32768

Parâmetros de resposta

Código de status: 200

Tabela 4 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

total_num

Long

Número total

Mínimo: 0

Máximo: 2147483647

data_list

Array of VulScanTaskInfo objects

Tarefas de verificação de vulnerabilidades

Comprimento da matriz: 0–2147483647

Tabela 5 VulScanTaskInfo

Parâmetro

Tipo

Descrição

id

String

ID da tarefa

Mínimo: 1

Máximo: 256

scan_type

String

Tipo de uma tarefa de verificação. As opções são as seguintes: -manual -schedule

Mínimo: 0

Máximo: 128

start_time

Long

Hora de início de uma tarefa de verificação.

Mínimo: 0

Máximo: 2147483647

end_time

Long

Hora de término de uma tarefa de verificação.

Mínimo: 0

Máximo: 2147483647

scan_vul_types

Array of strings

Lista de tipos de vulnerabilidades verificados pela tarefa

Mínimo: 1

Máximo: 32

Comprimento da matriz: 1–2147483647

status

String

Status de execução de uma tarefa de verificação. As opções são as seguintes: -running -finished

Mínimo: 1

Máximo: 32

scanning_host_num

Integer

O número de servidores que estão sendo verificados

Mínimo: 0

Máximo: 2147483647

success_host_num

Integer

Número de servidores que foram verificados com sucesso

Mínimo: 0

Máximo: 2147483647

failed_host_num

Integer

Número de servidores que não foram verificados

Mínimo: 0

Máximo: 2147483647

Exemplo de solicitações

Consultar informações sobre a tarefa de verificação de vulnerabilidades cujo tipo é verificação manual e task_id é 195db604-2008-4e8b-a49e-389ab0175beb. Por padrão, 10 registros na primeira página são consultados.

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

Exemplo de respostas

Código de status: 200

Tarefas de verificação 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 amostra do SDK

O código de amostra do SDK é o seguinte.

Java

Consultar informações sobre a tarefa de verificação de vulnerabilidades cujo tipo é verificação manual e task_id é 195db604-2008-4e8b-a49e-389ab0175beb. Por padrão, 10 registros na primeira página são consultados.

 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 informações sobre a tarefa de verificação de vulnerabilidades cujo tipo é verificação manual e task_id é 195db604-2008-4e8b-a49e-389ab0175beb. Por padrão, 10 registros na primeira página são consultados.

 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 informações sobre a tarefa de verificação de vulnerabilidades cujo tipo é verificação manual e task_id é 195db604-2008-4e8b-a49e-389ab0175beb. Por padrão, 10 registros na primeira página são consultados.

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

Mais

Para obter o código de amostra do SDK de mais linguagens de programação, consulte a guia Código de amostra no API Explorer. O código de amostra do SDK pode ser gerado automaticamente.

Códigos de status

Código de status

Descrição

200

Tarefas de verificação de vulnerabilidades

Códigos de erro

Consulte Códigos de erro.