Creating a Traffic Mirror Session

Function

This API is used to create a traffic mirror session.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
traffic_mirror_session	Yes	CreateTrafficMirrorSessionOption object	Traffic mirror session.

**Table 3** CreateTrafficMirrorSessionOption
Parameter	Mandatory	Type	Description
name	Yes	String	Traffic mirror session name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
description	No	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	Yes	String	Traffic mirror filter ID.
traffic_mirror_sources	Yes	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	Yes	String	Mirror target ID.
traffic_mirror_target_type	Yes	String	Mirror target type. The value can be eni (elastic network interface) or elb (private network load balancer).
virtual_network_id	No	String	VNI, which is used to distinguish mirrored traffic of different sessions. Value range: 0-16777215 Default value: 1
packet_length	No	String	Maximum transmission unit (MTU). Value range: 1-1460 Default value: 96
priority	Yes	Integer	Mirror session priority. Value range: 1-32766
enabled	No	String	Whether to enable a mirror session. The value can be true or false. Default value: false
type	No	String	Supported mirror source type. The value can be: eni: elastic network interface. eip: elastic IP.

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: 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.

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