Creating a Packet Capture Task
Function
Create a packet capture task. Each task can be executed only once.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/capture-task
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0. |
fw_instance_id |
Yes |
String |
Firewall ID, which can be obtained by referring to Obtaining a Firewall ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. You can obtain the token by referring to Obtaining a User Token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
destination |
Yes |
CaptureRuleAddressDto object |
Request body of the destination address in a packet capture rule. |
duration |
Yes |
Integer |
Packet capture duration, in minutes. |
max_packets |
Yes |
Integer |
Maximum number of captured packets. |
name |
Yes |
String |
Packet capture task name. |
service |
Yes |
CaptureServiceDto object |
Request body of a packet capture task. |
source |
Yes |
CaptureRuleAddressDto object |
Request body of the source address in a packet capture rule. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dest_port |
No |
String |
Destination port. |
protocol |
Yes |
Integer |
Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic). |
source_port |
No |
String |
Source port. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
CaptureTaskId object |
ID of a created packet capture task. |
Example Requests
Add a packet capture task to firewall ebf891cd-2163-48a0-9963-6309f99dd3c4 in project 09bb24e6fe80d23d2fa2c010b53b418c. Set the task name to zhuabaotest, maximum number of captured packets to 100000, packet capture duration to 3 minutes, and remaining retention days to 7 days. Source address protocol: TCP; address type: IPv4; address: 1.1.1.1; port number: 1-65535; destination address protocol: TCP; address type: IPv4; address: 2.2.2.2; port number: 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" : "" } }
Example Responses
Status code: 200
Return value for creating a packet capture task.
{ "data" : { "id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", "name" : "test" } }
SDK Sample Code
The SDK sample code is as follows.
Add a packet capture task to firewall ebf891cd-2163-48a0-9963-6309f99dd3c4 in project 09bb24e6fe80d23d2fa2c010b53b418c. Set the task name to zhuabaotest, maximum number of captured packets to 100000, packet capture duration to 3 minutes, and remaining retention days to 7 days. Source address protocol: TCP; address type: IPv4; address: 1.1.1.1; port number: 1-65535; destination address protocol: TCP; address type: IPv4; address: 2.2.2.2; port number: 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()); } } } |
Add a packet capture task to firewall ebf891cd-2163-48a0-9963-6309f99dd3c4 in project 09bb24e6fe80d23d2fa2c010b53b418c. Set the task name to zhuabaotest, maximum number of captured packets to 100000, packet capture duration to 3 minutes, and remaining retention days to 7 days. Source address protocol: TCP; address type: IPv4; address: 1.1.1.1; port number: 1-65535; destination address protocol: TCP; address type: IPv4; address: 2.2.2.2; port number: 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) |
Add a packet capture task to firewall ebf891cd-2163-48a0-9963-6309f99dd3c4 in project 09bb24e6fe80d23d2fa2c010b53b418c. Set the task name to zhuabaotest, maximum number of captured packets to 100000, packet capture duration to 3 minutes, and remaining retention days to 7 days. Source address protocol: TCP; address type: IPv4; address: 1.1.1.1; port number: 1-65535; destination address protocol: TCP; address type: IPv4; address: 2.2.2.2; port number: 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) } } |
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 |
Return value for creating a packet capture task. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot