Updated on 2024-10-11 GMT+08:00

Updating a Traffic Mirror Session

Function

This API is used to update a traffic mirror session.

Debugging

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

URI

PUT /v3/{project_id}/vpc/traffic-mirror-sessions/{traffic_mirror_session_id}

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.

traffic_mirror_session_id

Yes

String

Traffic mirror session ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

traffic_mirror_session

Yes

UpdateTrafficMirrorSessionOption object

Traffic mirror session.

Table 3 UpdateTrafficMirrorSessionOption

Parameter

Mandatory

Type

Description

name

No

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

No

String

Traffic mirror filter ID.

traffic_mirror_target_id

No

String

Mirror target ID.

traffic_mirror_target_type

No

String

Mirror target type.

The value can be eni (elastic network interface) or elb (private network load balancer).

virtual_network_id

No

Integer

VNI, which is used to distinguish mirrored traffic of different sessions for a mirror target.

Value range: 0-16777215

packet_length

No

Integer

Maximum transmission unit (MTU).

Value range: 1-1460

priority

No

Integer

Mirror session priority.

Value range: 1-32766

enabled

No

String

Whether to enable a mirror session.

The value can be true or false.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

traffic_mirror_session

TrafficMirrorSession object

Traffic mirror session.

request_id

String

Request ID.

Table 5 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.

Example Requests

Update the traffic mirror session with ID of 16538eda-7e94-4b90-b5f3-a653f62dc817, mirror target type of elb, and mirror target ID of c9f8acef-d550-4fbe-be7c-e8bfd3501dc1.

PUT http://{endpoint}/v3/{project_id}/vpc/traffic-mirror-sessions/16538eda-7e94-4b90-b5f3-a653f62dc817

{
  "traffic_mirror_session" : {
    "traffic_mirror_target_id" : "c9f8acef-d550-4fbe-be7c-e8bfd3501dc1",
    "traffic_mirror_target_type" : "elb"
  }
}

Example Responses

Status code: 200

OK

{
  "traffic_mirror_session" : {
    "name" : "test-session",
    "created_at" : "2023-03-23T10:53:12.000+00:00",
    "updated_at" : "2023-03-23T10:56:54.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" : "elb",
    "virtual_network_id" : 1,
    "packet_length" : 96,
    "priority" : 11,
    "enabled" : true,
    "type" : "eni"
  },
  "request_id" : "a7ee4a0e-12e9-457a-b739-46bffb2e7bbb"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.