更新时间:2024-10-31 GMT+08:00
分享

创建抓包任务

功能介绍

创建抓包任务,每个任务只能执行一次。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/capture-task

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

fw_instance_id

String

防火墙id,可通过防火墙ID获取方式获取

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。可通过如何获取用户Token获取。

表4 请求Body参数

参数

是否必选

参数类型

描述

destination

CaptureRuleAddressDto object

抓包规则目的地址请求体

duration

Integer

抓包时长,以分钟为单位

max_packets

Integer

最大抓包数,以个为单位

name

String

抓包任务名称

service

CaptureServiceDto object

抓包任务服务请求体

source

CaptureRuleAddressDto object

抓包规则源地址请求体

表5 CaptureServiceDto

参数

是否必选

参数类型

描述

dest_port

String

目的端口

protocol

Integer

协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空,自动类型为空

source_port

String

源端口

表6 CaptureRuleAddressDto

参数

是否必选

参数类型

描述

address

String

地址

address_type

Integer

目的地址类型0 ipv4,1 ipv6

type

Integer

输入地址类型,目前只支持0,手工输入类型

响应参数

状态码: 200

表7 响应Body参数

参数

参数类型

描述

data

CaptureTaskId object

创建抓包任务id信息

表8 CaptureTaskId

参数

参数类型

描述

id

String

防火墙id

name

String

防火墙名称

请求示例

向项目id为09bb24e6fe80d23d2fa2c010b53b418c,防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4添加抓包任务,任务名称为zhuabaotest,最大抓包数为100000,抓包时长为3分钟,剩余保留天数为7天,源地址协议为tcp协议,地址类型为ipv4,地址为1.1.1.1,端口号为1-65535,目的地址协议为tcp协议,地址类型为ipv4,地址为2.2.2.2,端口号为1-65535。

https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default

{
  "name" : "zhuabaotest",
  "max_packets" : 100000,
  "duration" : 3,
  "source" : {
    "type" : 0,
    "address_type" : 0,
    "address" : "1.1.1.1"
  },
  "destination" : {
    "type" : 0,
    "address_type" : 0,
    "address" : "2.2.2.2"
  },
  "service" : {
    "protocol" : -1,
    "source_port" : "",
    "dest_port" : ""
  }
}

响应示例

状态码: 200

创建抓包任务返回值

{
  "data" : {
    "id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4",
    "name" : "test"
  }
}

SDK代码示例

SDK代码示例如下。

Java

向项目id为09bb24e6fe80d23d2fa2c010b53b418c,防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4添加抓包任务,任务名称为zhuabaotest,最大抓包数为100000,抓包时长为3分钟,剩余保留天数为7天,源地址协议为tcp协议,地址类型为ipv4,地址为1.1.1.1,端口号为1-65535,目的地址协议为tcp协议,地址类型为ipv4,地址为2.2.2.2,端口号为1-65535。

 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
65
66
67
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.cfw.v1.region.CfwRegion;
import com.huaweicloud.sdk.cfw.v1.*;
import com.huaweicloud.sdk.cfw.v1.model.*;


public class CreateCaptureTaskSolution {

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

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateCaptureTaskRequest request = new CreateCaptureTaskRequest();
        CaptureTaskDto body = new CaptureTaskDto();
        CaptureRuleAddressDto sourcebody = new CaptureRuleAddressDto();
        sourcebody.withAddress("1.1.1.1")
            .withAddressType(0)
            .withType(0);
        CaptureServiceDto servicebody = new CaptureServiceDto();
        servicebody.withDestPort("")
            .withProtocol(-1)
            .withSourcePort("");
        CaptureRuleAddressDto destinationbody = new CaptureRuleAddressDto();
        destinationbody.withAddress("2.2.2.2")
            .withAddressType(0)
            .withType(0);
        body.withSource(sourcebody);
        body.withService(servicebody);
        body.withName("zhuabaotest");
        body.withMaxPackets(100000);
        body.withDuration(3);
        body.withDestination(destinationbody);
        request.withBody(body);
        try {
            CreateCaptureTaskResponse response = client.createCaptureTask(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

向项目id为09bb24e6fe80d23d2fa2c010b53b418c,防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4添加抓包任务,任务名称为zhuabaotest,最大抓包数为100000,抓包时长为3分钟,剩余保留天数为7天,源地址协议为tcp协议,地址类型为ipv4,地址为1.1.1.1,端口号为1-65535,目的地址协议为tcp协议,地址类型为ipv4,地址为2.2.2.2,端口号为1-65535。

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = CreateCaptureTaskRequest()
        sourcebody = CaptureRuleAddressDto(
            address="1.1.1.1",
            address_type=0,
            type=0
        )
        servicebody = CaptureServiceDto(
            dest_port="",
            protocol=-1,
            source_port=""
        )
        destinationbody = CaptureRuleAddressDto(
            address="2.2.2.2",
            address_type=0,
            type=0
        )
        request.body = CaptureTaskDto(
            source=sourcebody,
            service=servicebody,
            name="zhuabaotest",
            max_packets=100000,
            duration=3,
            destination=destinationbody
        )
        response = client.create_capture_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

向项目id为09bb24e6fe80d23d2fa2c010b53b418c,防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4添加抓包任务,任务名称为zhuabaotest,最大抓包数为100000,抓包时长为3分钟,剩余保留天数为7天,源地址协议为tcp协议,地址类型为ipv4,地址为1.1.1.1,端口号为1-65535,目的地址协议为tcp协议,地址类型为ipv4,地址为2.2.2.2,端口号为1-65535。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateCaptureTaskRequest{}
	sourcebody := &model.CaptureRuleAddressDto{
		Address: "1.1.1.1",
		AddressType: int32(0),
		Type: int32(0),
	}
	destPortService:= ""
	sourcePortService:= ""
	servicebody := &model.CaptureServiceDto{
		DestPort: &destPortService,
		Protocol: int32(-1),
		SourcePort: &sourcePortService,
	}
	destinationbody := &model.CaptureRuleAddressDto{
		Address: "2.2.2.2",
		AddressType: int32(0),
		Type: int32(0),
	}
	request.Body = &model.CaptureTaskDto{
		Source: sourcebody,
		Service: servicebody,
		Name: "zhuabaotest",
		MaxPackets: int32(100000),
		Duration: int32(3),
		Destination: destinationbody,
	}
	response, err := client.CreateCaptureTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

创建抓包任务返回值

错误码

请参见错误码

相关文档