Updated on 2024-07-01 GMT+08:00

Create capture task

Function

Create capture task

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/capture-task

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

fw_instance_id

Yes

String

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

destination

Yes

CaptureRuleAddressDto object

capture rule address dto

duration

Yes

Integer

capture duration

max_packets

Yes

Integer

max packets

Maximum: 1000000

name

Yes

String

capture name

service

Yes

CaptureServiceDto object

capture service dto

source

Yes

CaptureRuleAddressDto object

capture rule address dto

Table 5 CaptureServiceDto

Parameter

Mandatory

Type

Description

dest_port

No

String

destination port

protocol

Yes

Integer

Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

source_port

No

String

source port

Table 6 CaptureRuleAddressDto

Parameter

Mandatory

Type

Description

address

Yes

String

address

address_type

Yes

Integer

Address type. The value can be 0 (IPv4), 1 (IPv6)

type

Yes

Integer

input address type, manual means 0, only 0 is supported.

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

data

IdObject object

create capture task response info

Table 8 IdObject

Parameter

Type

Description

id

String

ID

name

String

name

Example Requests

Add a packet capture task to the project ID 09bb24e6fe80d23d2fa2c010b53b418c and the firewall id ebf891cd-2163-48a0-9963-6309f99dd3c4 with the task name zhuabaotest, the maximum number of packet captures is 100,000, the packet capture duration is 3 minutes, the remaining retention days are 7 days, the source address protocol is tcp protocol, and the address type is IPv4. The address is 1.1.1.1, the port number is 1-65535, the destination address protocol is TCP, the address type is IPv4, the address is 2.2.2.2, and the port number is 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,
  "hold_day" : 7,
  "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" : ""
  }
}

Example Responses

Status code: 200

Create capture task response

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

SDK Sample Code

The SDK sample code is as follows.

Java

Add a packet capture task to the project ID 09bb24e6fe80d23d2fa2c010b53b418c and the firewall id ebf891cd-2163-48a0-9963-6309f99dd3c4 with the task name zhuabaotest, the maximum number of packet captures is 100,000, the packet capture duration is 3 minutes, the remaining retention days are 7 days, the source address protocol is tcp protocol, and the address type is IPv4. The address is 1.1.1.1, the port number is 1-65535, the destination address protocol is TCP, the address type is IPv4, the address is 2.2.2.2, and the port number is 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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateCaptureTaskRequest request = new CreateCaptureTaskRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withFwInstanceId("<fw_instance_id>");
        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

Add a packet capture task to the project ID 09bb24e6fe80d23d2fa2c010b53b418c and the firewall id ebf891cd-2163-48a0-9963-6309f99dd3c4 with the task name zhuabaotest, the maximum number of packet captures is 100,000, the packet capture duration is 3 minutes, the remaining retention days are 7 days, the source address protocol is tcp protocol, and the address type is IPv4. The address is 1.1.1.1, the port number is 1-65535, the destination address protocol is TCP, the address type is IPv4, the address is 2.2.2.2, and the port number is 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
# 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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = CreateCaptureTaskRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.fw_instance_id = "<fw_instance_id>"
        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

Add a packet capture task to the project ID 09bb24e6fe80d23d2fa2c010b53b418c and the firewall id ebf891cd-2163-48a0-9963-6309f99dd3c4 with the task name zhuabaotest, the maximum number of packet captures is 100,000, the packet capture duration is 3 minutes, the remaining retention days are 7 days, the source address protocol is tcp protocol, and the address type is IPv4. The address is 1.1.1.1, the port number is 1-65535, the destination address protocol is TCP, the address type is IPv4, the address is 2.2.2.2, and the port number is 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
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")

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

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

    request := &model.CreateCaptureTaskRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	request.FwInstanceId = "<fw_instance_id>"
	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)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Create capture task response

Error Codes

See Error Codes.