Associating a Traffic Mirror Source with a Traffic Mirror Session
Function
This API is used to associate a traffic mirror source with a traffic mirror session.
URI
PUT /v3/{project_id}/vpc/traffic-mirror-sessions/{traffic_mirror_session_id}/add-sources
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
traffic_mirror_session_id |
Yes |
String |
Traffic mirror session ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
traffic_mirror_session |
Yes |
TrafficMirrorSourcesOption object |
Traffic mirror session. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
traffic_mirror_session |
TrafficMirrorSession object |
Traffic mirror session. |
request_id |
String |
Request ID. |
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. |
Example Requests
Associate the mirror source 6134900d-31a6-4b71-8453-dbca7f26982e with the mirror session e15a6e40-2580-4949-bf2a-55ee7cd49392.
PUT https://{endpoint}/v3/{project_id}/vpc/traffic-mirror-sessions/e15a6e40-2580-4949-bf2a-55ee7cd49392/add-sources { "traffic_mirror_session" : { "traffic_mirror_sources" : [ "6134900d-31a6-4b71-8453-dbca7f26982e" ] } }
Example Responses
Status code: 200
OK
{ "traffic_mirror_session" : { "name" : "test-session", "created_at" : "2023-02-23T06:57:39.000+00:00", "updated_at" : "2023-02-23T06:57:39.000+00:00", "id" : "e15a6e40-2580-4949-bf2a-55ee7cd49392", "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" : "1adbc9b3-df85-4343-948a-d129536fa309", "traffic_mirror_target_type" : "eni", "virtual_network_id" : 1, "packet_length" : 96, "priority" : 6, "enabled" : true, "type" : "eni" }, "request_id" : "be17b2e9-098c-4b56-ac0c-97e6b6413f12" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
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