Updated on 2025-08-19 GMT+08:00

Querying Traffic Mirror Sessions

Function

This API is used to query information about all traffic mirror sessions, including the name and type.

Calling Method

For details, see Calling APIs.

URI

GET /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.

Range:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

id

No

Array of strings

Definition:

ID of a traffic mirror session. You can use this field to accurately filter traffic mirror sessions. Multiple IDs can be specified for filtering.

Range:

N/A

name

No

Array of strings

Definition:

Name of a traffic mirror session. You can use this field to filter traffic mirror sessions. Multiple names can be specified for filtering.

Range:

N/A

description

No

Array of strings

Definition:

Description of a traffic mirror session. You can use this field to filter traffic mirror sessions. Multiple descriptions can be specified for filtering.

Range:

N/A

enabled

No

Boolean

Definition:

Whether a traffic mirror session is enabled. You can use this field to filter traffic mirror sessions. Only one value can be specified for filtering.

Range:

  • true: Filter traffic mirror sessions that are enabled.

  • false: Filter traffic mirror sessions that are disabled.

packet_length

No

Array of integers

Definition:

Packet length of a traffic mirror session. You can use this field to filter traffic mirror sessions. Multiple packet lengths can be specified for filtering.

Range:

1 to 1460

priority

No

Array of integers

Definition:

Priority of a traffic mirror session. You can use this field to filter traffic mirror sessions. Multiple priorities can be specified for filtering.

Range:

1 to 32766

traffic_mirror_filter_id

No

Array of strings

Definition:

ID of the traffic mirror filter associated with a traffic mirror session. You can use this field to filter traffic mirror sessions. Multiple IDs can be specified for filtering.

Range:

N/A

traffic_mirror_target_type

No

Array of strings

Definition:

Type of the traffic mirror target associated with a traffic mirror session. You can use this field to filter traffic mirror sessions. Multiple types can be specified for filtering.

Range:

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

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

traffic_mirror_target_id

No

Array of strings

Definition:

ID of the traffic mirror target associated with a traffic mirror session. You can use this field to filter traffic mirror sessions. Multiple IDs can be specified for filtering.

Range:

N/A

type

No

Array of strings

Definition:

Type of the traffic mirror source associated with a traffic mirror session. You can use this field to filter traffic mirror sessions. Multiple types can be specified for filtering.

Range:

  • eni: elastic network interface

  • eip: EIP

virtual_network_id

No

Array of integers

Definition:

VXLAN network identifier (VNI) of a traffic mirror session. You can use this field to filter traffic mirror sessions. Multiple VNIs can be specified for filtering.

Range:

0 to 16777215

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

traffic_mirror_sessions

Array of TrafficMirrorSession objects

Definition:

Response body for querying traffic mirror sessions.

Range:

N/A

page_info

PageInfo object

Definition:

Pagination information.

Range:

N/A

request_id

String

Definition:

Request ID.

Range:

N/A

Table 4 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:

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

description

String

Definition:

Description of a traffic mirror session.

Range:

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

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 can be used as the traffic mirror sources.

Range:

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

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) of a traffic mirror session, which is used to distinguish different mirror sessions.

Range:

The value is from 0 to 16777215. The default value is 1.

packet_length

Integer

Definition:

Packet length of a traffic mirror session.

Range:

The value is from 1 to 1460. The default value is 96.

priority

Integer

Definition:

Priority of a traffic mirror session.

Range:

1 to 32766

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

created_at

String

Definition:

Time when a traffic mirror session was created.

Range:

The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.

updated_at

String

Definition:

Time when a traffic mirror session was updated.

Range:

The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.

Table 5 PageInfo

Parameter

Type

Description

previous_marker

String

Definition:

The first record on the current page.

Range:

N/A

current_count

Integer

Definition:

Total number of resources on the current page.

Range:

N/A

next_marker

String

Definition:

The last record on the current page. The next_marker field does not exist if the page is the last one.

Range:

N/A

Example Requests

Querying traffic mirror sessions

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

Example Responses

Status code: 200

OK

{
  "request_id" : "f87354b7-eecd-4b64-87f6-bfd6430e33bd",
  "traffic_mirror_sessions" : [ {
    "name" : "test-session",
    "created_at" : "2023-03-14T08:44:12.000+00:00",
    "updated_at" : "2023-03-14T08:44:12.000+00:00",
    "id" : "6cc12480-5a92-4aed-99fb-07c52cc98961",
    "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" : "029ab12b-dc38-4228-b146-44975bf55250",
    "traffic_mirror_target_type" : "eni",
    "virtual_network_id" : 1,
    "packet_length" : 96,
    "priority" : 9,
    "enabled" : true,
    "type" : "eni"
  } ],
  "page_info" : {
    "previous_marker" : "6cc12480-5a92-4aed-99fb-07c52cc98961",
    "current_count" : 1
  }
}

SDK Sample Code

The SDK sample code is as follows.

 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
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.*;


public class ListTrafficMirrorSessionsSolution {

    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();
        ListTrafficMirrorSessionsRequest request = new ListTrafficMirrorSessionsRequest();
        try {
            ListTrafficMirrorSessionsResponse response = client.listTrafficMirrorSessions(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());
        }
    }
}
 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
# 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 = ListTrafficMirrorSessionsRequest()
        response = client.list_traffic_mirror_sessions(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := vpc.NewVpcClient(
        vpc.VpcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListTrafficMirrorSessionsRequest{}
	response, err := client.ListTrafficMirrorSessions(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

OK

Error Codes

See Error Codes.