Updated on 2026-07-29 GMT+08:00

Creating a Traffic Mirror Session

Function

This API is used to create a mirror session. A mirror session can be associated with a mirror filter, multiple mirror sources, and a mirror target. A mirror session mirrors traffic from a mirror source to a mirror target that meets the mirror filter.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    vpc:trafficMirrorSessions:create

    Write

    trafficMirrorSession *

    • vpc:TrafficMirrorTargetType

    • vpc:TrafficMirrorTargetId

    • vpc:TrafficMirrorSourceType

    • vpc:TrafficMirrorSourceId

    • vpc:TrafficMirrorFilterId

    -

    -

    trafficMirrorFilter *

    -

URI

POST /v3/{project_id}/vpc/traffic-mirror-sessions

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

ID of the project that a traffic mirror session belongs to. For details about how to obtain a project ID, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

traffic_mirror_session

Yes

CreateTrafficMirrorSessionOption object

Definition

Traffic mirror session.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 CreateTrafficMirrorSessionOption

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Name of a traffic mirror session.

Constraints

The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

Range

N/A

Default Value

N/A

description

No

String

Definition

Description of a traffic mirror session.

Constraints

The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).

Range

N/A

Default Value

N/A

traffic_mirror_filter_id

Yes

String

Definition

Traffic mirror filter ID.

Constraints

N/A

Range

N/A

Default Value

N/A

traffic_mirror_sources

Yes

Array of strings

Definition

IDs of the mirror sources. Elastic network interfaces, EIPs, and listeners of load balancers can be used as the mirror sources.

Constraints

Each traffic mirror session can have up to 10 mirror sources by default.

Range

N/A

Default Value

N/A

traffic_mirror_target_id

Yes

String

Definition

Mirror target ID.

Constraints

N/A

Range

N/A

Default Value

N/A

traffic_mirror_target_type

Yes

String

Definition

Mirror target type.

Constraints

N/A

Range

  • eni: elastic network interface

  • elb: private network load balancer

Default Value

N/A

virtual_network_id

No

String

Definition

VXLAN network identifier (VNI).

A mirror target can be associated with multiple mirror sessions. The VNI is used to distinguish different mirror sessions for the mirror target.

Constraints

N/A

Range

0 to 16777215

Default Value

1

packet_length

No

String

Definition

The number of bytes that meet the mirror filter and will be mirrored.

Constraints

N/A

Range

1 to 1460 bytes

Default Value

96 bytes

priority

Yes

Integer

Definition

Priority of a mirror session.

Constraints

  • Priorities must be unique for each mirror session of the same account in a region.

  • A mirror source can be associated with multiple mirror sessions at the same time. The mirror sessions are matched from the lowest value to the highest value.

Range

The value ranges from 1 to 32766. A smaller value indicates a higher priority.

Default Value

N/A

enabled

No

String

Definition

Whether the traffic mirror session is enabled. This field can be used to filter traffic mirror sessions.

Constraints

Filtering by multiple values is not supported.

Range

  • true: Filter traffic mirror sessions that are enabled.

  • false: Filter traffic mirror sessions that are disabled.

Default Value

false

type

No

String

Definition

Supported mirror source type.

Constraints

N/A

Range

  • eni: elastic network interface

  • eip: EIP

  • listener: load balancer's listener

Default Value

N/A

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

traffic_mirror_session

TrafficMirrorSession object

Definition:

Response body for querying details about a traffic mirror session.

Range:

N/A

request_id

String

Definition:

Request ID.

Range:

N/A

Table 5 TrafficMirrorSession

Parameter

Type

Description

id

String

Definition:

ID of a traffic mirror session. After a traffic mirror session is created, a traffic mirror session ID is generated, which uniquely identifies the traffic mirror session.

Range:

N/A

project_id

String

Definition:

ID of the project that a traffic mirror session belongs to.

Range:

N/A

name

String

Definition

Name of a traffic mirror session.

Range

N/A

description

String

Definition

Description of a traffic mirror session.

Range

N/A

traffic_mirror_filter_id

String

Definition:

ID of the traffic mirror filter that a traffic mirror session is associated with.

Range:

N/A

traffic_mirror_sources

Array of strings

Definition

IDs of the traffic mirror sources that a traffic mirror session is associated with. Elastic network interfaces, EIPs, and listeners of load balancers can be used as the traffic mirror sources.

Range

N/A

traffic_mirror_target_id

String

Definition:

ID of the traffic mirror target that a traffic mirror session is associated with.

Range:

N/A

traffic_mirror_target_type

String

Definition:

Type of the traffic mirror target that a traffic mirror session is associated with.

Range:

  • eni: The mirror target is an elastic network interface.

  • elb: The mirror target is a private network load balancer.

virtual_network_id

Integer

Definition

VXLAN network identifier (VNI).

A mirror target can be associated with multiple mirror sessions. The VNI is used to distinguish different mirror sessions for the mirror target.

Range

0 to 16777215

packet_length

Integer

Definition

The number of bytes that meet the mirror filter and will be mirrored.

Constraints

N/A

Range

1 to 1460 bytes

Default Value

96 bytes

priority

Integer

Definition

Priority of a mirror session.

Range

The value ranges from 1 to 32766. A smaller value indicates a higher priority.

enabled

Boolean

Definition:

Whether to enable a traffic mirror session.

Range:

  • true: The traffic mirror session is enabled.

  • false (default value): The traffic mirror session is disabled.

type

String

Definition:

Type of the traffic mirror source that a traffic mirror session is associated with.

Range:

  • eni: elastic network interface

  • eip: EIP

  • listener: ELB listener

created_at

String

Definition

Time when a traffic mirror session was created.

Range

N/A

updated_at

String

Definition

Time when a traffic mirror session was updated.

Range

N/A

Example Requests

Create a traffic mirror session named test-session.

POST http://{endpoint}/v3/{project_id}/vpc/traffic-mirror-sessions

{
  "traffic_mirror_session" : {
    "name" : "test-session",
    "traffic_mirror_filter_id" : "b765ba87-c0b4-4f1a-9ec3-d5b1d1ddb137",
    "traffic_mirror_sources" : [ "6134900d-31a6-4b71-8453-dbca7f26982a" ],
    "traffic_mirror_target_id" : "c9f8acef-d550-4fbe-be7c-e8bfd3501dc1",
    "traffic_mirror_target_type" : "eni",
    "priority" : 11
  }
}

Example Responses

Status code: 201

Created

{
  "traffic_mirror_session" : {
    "name" : "test-session",
    "created_at" : "2023-03-23T10:53:12.000+00:00",
    "updated_at" : "2023-03-23T10:53:12.000+00:00",
    "id" : "16538eda-7e94-4b90-b5f3-a653f62dc817",
    "project_id" : "7365fcd452924e398ec4cc1fe39c0d12",
    "description" : "",
    "traffic_mirror_filter_id" : "b765ba87-c0b4-4f1a-9ec3-d5b1d1ddb137",
    "traffic_mirror_sources" : [ "6134900d-31a6-4b71-8453-dbca7f26982a" ],
    "traffic_mirror_target_id" : "c9f8acef-d550-4fbe-be7c-e8bfd3501dc1",
    "traffic_mirror_target_type" : "eni",
    "virtual_network_id" : 1,
    "packet_length" : 96,
    "priority" : 11,
    "enabled" : true,
    "type" : "eni"
  },
  "request_id" : "9a880225-1d2f-461e-8d8e-1866bfda77db"
}

SDK Sample Code

The SDK sample code is as follows.

Create a traffic mirror session named test-session.

 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
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.vpc.v3.region.VpcRegion;
import com.huaweicloud.sdk.vpc.v3.*;
import com.huaweicloud.sdk.vpc.v3.model.*;

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

public class CreateTrafficMirrorSessionSolution {

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

        VpcClient client = VpcClient.newBuilder()
                .withCredential(auth)
                .withRegion(VpcRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateTrafficMirrorSessionRequest request = new CreateTrafficMirrorSessionRequest();
        CreateTrafficMirrorSessionRequestBody body = new CreateTrafficMirrorSessionRequestBody();
        List<String> listTrafficMirrorSessionTrafficMirrorSources = new ArrayList<>();
        listTrafficMirrorSessionTrafficMirrorSources.add("6134900d-31a6-4b71-8453-dbca7f26982a");
        CreateTrafficMirrorSessionOption trafficMirrorSessionbody = new CreateTrafficMirrorSessionOption();
        trafficMirrorSessionbody.withName("test-session")
            .withTrafficMirrorFilterId("b765ba87-c0b4-4f1a-9ec3-d5b1d1ddb137")
            .withTrafficMirrorSources(listTrafficMirrorSessionTrafficMirrorSources)
            .withTrafficMirrorTargetId("c9f8acef-d550-4fbe-be7c-e8bfd3501dc1")
            .withTrafficMirrorTargetType("eni")
            .withPriority(11);
        body.withTrafficMirrorSession(trafficMirrorSessionbody);
        request.withBody(body);
        try {
            CreateTrafficMirrorSessionResponse response = client.createTrafficMirrorSession(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());
        }
    }
}

Create a traffic mirror session named test-session.

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkvpc.v3 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 = VpcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(VpcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateTrafficMirrorSessionRequest()
        listTrafficMirrorSourcesTrafficMirrorSession = [
            "6134900d-31a6-4b71-8453-dbca7f26982a"
        ]
        trafficMirrorSessionbody = CreateTrafficMirrorSessionOption(
            name="test-session",
            traffic_mirror_filter_id="b765ba87-c0b4-4f1a-9ec3-d5b1d1ddb137",
            traffic_mirror_sources=listTrafficMirrorSourcesTrafficMirrorSession,
            traffic_mirror_target_id="c9f8acef-d550-4fbe-be7c-e8bfd3501dc1",
            traffic_mirror_target_type="eni",
            priority=11
        )
        request.body = CreateTrafficMirrorSessionRequestBody(
            traffic_mirror_session=trafficMirrorSessionbody
        )
        response = client.create_traffic_mirror_session(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Create a traffic mirror session named test-session.

 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"
    vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := vpc.VpcClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := vpc.NewVpcClient(hcClient)

    request := &model.CreateTrafficMirrorSessionRequest{}
	var listTrafficMirrorSourcesTrafficMirrorSession = []string{
        "6134900d-31a6-4b71-8453-dbca7f26982a",
    }
	trafficMirrorSessionbody := &model.CreateTrafficMirrorSessionOption{
		Name: "test-session",
		TrafficMirrorFilterId: "b765ba87-c0b4-4f1a-9ec3-d5b1d1ddb137",
		TrafficMirrorSources: listTrafficMirrorSourcesTrafficMirrorSession,
		TrafficMirrorTargetId: "c9f8acef-d550-4fbe-be7c-e8bfd3501dc1",
		TrafficMirrorTargetType: "eni",
		Priority: int32(11),
	}
	request.Body = &model.CreateTrafficMirrorSessionRequestBody{
		TrafficMirrorSession: trafficMirrorSessionbody,
	}
	response, err := client.CreateTrafficMirrorSession(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

201

Created

Error Codes

See Error Codes.