Querying Traffic Mirror Sessions

Function

This API is used to query traffic mirror sessions.

Debugging

You can debug this API through automatic authentication in API Explorer.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
id	No	String	Filter or sort by mirror session ID.
name	No	String	Filter or sort by mirror session name.
description	No	String	Filter by mirror session description.
enabled	No	String	Filter by enabled.
packet_length	No	String	Filter by maximum transmission unit (MTU).
priority	No	String	Filter by mirror session priority.
traffic_mirror_filter_id	No	String	Filter by filter ID.
traffic_mirror_target_type	No	String	Filter by mirror target type.
traffic_mirror_target_id	No	String	Filter by mirror target ID.
type	No	String	Filter by mirror source type.
virtual_network_id	No	String	Filter by VNI.
created_at	No	String	Sort by creation time.
updated_at	No	String	Sort by update time.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
traffic_mirror_sessions	Array of TrafficMirrorSession objects	Traffic mirror sessions.
page_info	PageInfo object	Pagination information.
request_id	String	Request ID.

**Table 4** TrafficMirrorSession
Parameter	Type	Description
id	String	Traffic mirror session ID.
project_id	String	Project ID.
name	String	Traffic mirror session name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
description	String	Description of a traffic mirror session. The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
traffic_mirror_filter_id	String	Traffic mirror filter ID.
traffic_mirror_sources	Array of strings	Mirror source IDs. An elastic network interface can be used as a mirror source. Each mirror session can have up to 10 mirror sources by default.
traffic_mirror_target_id	String	Mirror target ID.
traffic_mirror_target_type	String	Mirror target type. The value can be eni (elastic network interface) or elb (private network load balancer).
virtual_network_id	Integer	VNI, which is used to distinguish mirrored traffic of different sessions. Value range: 0-16777215. Default value: 1
packet_length	Integer	Maximum transmission unit (MTU). Value range: 1-1460 Default value: 96
priority	Integer	Mirror session priority. Value range: 1-32766
enabled	Boolean	Whether to enable a mirror session. The value can be true or false. Default value: false
type	String	Supported mirror source type. The value can be eni (elastic network interface).
created_at	String	Time when a traffic mirror session is created.
updated_at	String	Time when a traffic mirror session is updated.

**Table 5** PageInfo
Parameter	Type	Description
previous_marker	String	First record on the current page.
current_count	Integer	Total number of records on the current page.
next_marker	String	Last record on the current page. This parameter does not exist if the page is the last one.

Example Requests

Querying traffic mirror sessions.

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

Example Responses

Status code: 200

{
  "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
  }
}