更新时间:2024-07-29 GMT+08:00

创建扫描任务

功能介绍

根据指定的任务名称、扫描方式、扫描周期、扫描规则组、扫描时间创建扫描任务

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/sdg/scan/job

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

asset_ids

Array of strings

资产ID列表

cycle

String

扫描周期,日(DAY),周(WEEK),月(MONTH),单次扫描(ONCE)

枚举值:

  • ONCE

  • DAY

  • WEEK

  • MONTH

name

String

扫描任务名

open

Boolean

是否开启任务

rule_group_ids

Array of strings

规则组ID列表

start_time

Long

扫描任务开始时间

time_zone

String

时区

topic_urn

String

主题的唯一资源标识符

use_nlp

Boolean

是否用nlp

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

msg

String

返回消息

status

String

返回状态,如'200','400'

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

创建任务名为xxxx的扫描任务,选择xxxxxxxxxxxx规则组,单次扫描,立即执行。

POST /v1/{project_id}/sdg/scan/job

{
  "asset_ids" : [ "xxxx", "xxxx" ],
  "cycle" : "ONCE",
  "name" : "xxxx",
  "open" : true,
  "rule_group_ids" : [ "xxxx", "xxxx" ],
  "start_time" : 0,
  "time_zone" : 8,
  "topic_urn" : "xxxxxxxxxxxx",
  "use_nlp" : false
}

响应示例

状态码: 200

请求成功

{
  "msg" : "xxxx",
  "status" : "RESPONSE_SUCCESS"
}

状态码: 400

无效请求

{
  "error_code" : "dsc.40000011",
  "error_msg" : "Invalid parameter"
}

SDK代码示例

SDK代码示例如下。

创建任务名为xxxx的扫描任务,选择xxxxxxxxxxxx规则组,单次扫描,立即执行。

 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
53
54
55
56
57
58
59
60
61
62
63
64
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.dsc.v1.region.DscRegion;
import com.huaweicloud.sdk.dsc.v1.*;
import com.huaweicloud.sdk.dsc.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class AddScanJobSolution {

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

        DscClient client = DscClient.newBuilder()
                .withCredential(auth)
                .withRegion(DscRegion.valueOf("<YOUR REGION>"))
                .build();
        AddScanJobRequest request = new AddScanJobRequest();
        ScanJobRequest body = new ScanJobRequest();
        List<String> listbodyRuleGroupIds = new ArrayList<>();
        listbodyRuleGroupIds.add("xxxx");
        listbodyRuleGroupIds.add("xxxx");
        List<String> listbodyAssetIds = new ArrayList<>();
        listbodyAssetIds.add("xxxx");
        listbodyAssetIds.add("xxxx");
        body.withUseNlp(false);
        body.withTopicUrn("xxxxxxxxxxxx");
        body.withTimeZone("8");
        body.withStartTime(0L);
        body.withRuleGroupIds(listbodyRuleGroupIds);
        body.withOpen(true);
        body.withName("xxxx");
        body.withCycle(ScanJobRequest.CycleEnum.fromValue("ONCE"));
        body.withAssetIds(listbodyAssetIds);
        request.withBody(body);
        try {
            AddScanJobResponse response = client.addScanJob(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());
        }
    }
}

创建任务名为xxxx的扫描任务,选择xxxxxxxxxxxx规则组,单次扫描,立即执行。

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdsc.v1.region.dsc_region import DscRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdsc.v1 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"]

    credentials = BasicCredentials(ak, sk)

    client = DscClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DscRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = AddScanJobRequest()
        listRuleGroupIdsbody = [
            "xxxx",
            "xxxx"
        ]
        listAssetIdsbody = [
            "xxxx",
            "xxxx"
        ]
        request.body = ScanJobRequest(
            use_nlp=False,
            topic_urn="xxxxxxxxxxxx",
            time_zone="8",
            start_time=0,
            rule_group_ids=listRuleGroupIdsbody,
            open=True,
            name="xxxx",
            cycle="ONCE",
            asset_ids=listAssetIdsbody
        )
        response = client.add_scan_job(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建任务名为xxxx的扫描任务,选择xxxxxxxxxxxx规则组,单次扫描,立即执行。

 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
53
54
55
56
57
58
59
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/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 := dsc.NewDscClient(
        dsc.DscClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.AddScanJobRequest{}
	var listRuleGroupIdsbody = []string{
        "xxxx",
	    "xxxx",
    }
	var listAssetIdsbody = []string{
        "xxxx",
	    "xxxx",
    }
	useNlpScanJobRequest:= false
	topicUrnScanJobRequest:= "xxxxxxxxxxxx"
	timeZoneScanJobRequest:= "8"
	startTimeScanJobRequest:= int64(0)
	openScanJobRequest:= true
	request.Body = &model.ScanJobRequest{
		UseNlp: &useNlpScanJobRequest,
		TopicUrn: &topicUrnScanJobRequest,
		TimeZone: &timeZoneScanJobRequest,
		StartTime: &startTimeScanJobRequest,
		RuleGroupIds: listRuleGroupIdsbody,
		Open: &openScanJobRequest,
		Name: "xxxx",
		Cycle: model.GetScanJobRequestCycleEnum().ONCE,
		AssetIds: listAssetIdsbody,
	}
	response, err := client.AddScanJob(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功

400

无效请求

错误码

请参见错误码