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

Creating a Traffic Mirror Filter Rule

Function

This API is used to create a traffic mirror filter rule.

Debugging

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

URI

POST /v3/{project_id}/vpc/traffic-mirror-filter-rules

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.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

traffic_mirror_filter_rule

Yes

CreateTrafficMirrorFilterRuleOption object

Traffic mirror filter rule.

Table 3 CreateTrafficMirrorFilterRuleOption

Parameter

Mandatory

Type

Description

description

No

String

Description of a traffic mirror filter rule.

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.

direction

Yes

String

Traffic direction.

The value can be ingress or egress.

protocol

Yes

String

Protocol of the mirrored traffic.

The value can be TCP, UDP, ICMP, ICMPV6, or ALL.

ethertype

Yes

String

IP address version of the mirrored traffic

The value can be IPv4 or IPv6.

source_cidr_block

No

String

Source CIDR block of the mirrored traffic.

destination_cidr_block

No

String

Destination CIDR block of the mirrored traffic.

source_port_range

No

String

Source port range.

Value range: 1-65535

Format: 80-200

destination_port_range

No

String

Destination port range.

Value range: 1-65535

Format: 80-200

action

Yes

String

Whether to accept or reject traffic.

The value can be accept or reject.

priority

Yes

Integer

Mirror filter rule priority.

Value range: 1-65535.

A smaller value indicates a higher priority.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

traffic_mirror_filter_rule

TrafficMirrorFilterRule object

Traffic mirror filter rule.

request_id

String

Request ID.

Table 5 TrafficMirrorFilterRule

Parameter

Type

Description

id

String

Traffic mirror filter rule ID.

project_id

String

Project ID.

description

String

Description of a traffic mirror filter rule.

The value can contain no more than 255 characters and cannot contain angle brackets (< or >).

traffic_mirror_filter_id

String

Traffic mirror filter ID.

direction

String

Traffic direction.

The value can be ingress or egress.

source_cidr_block

String

Source CIDR block of the mirrored traffic.

destination_cidr_block

String

Destination CIDR block of the mirrored traffic.

source_port_range

String

Source port range.

Value range: 1-65535

Format: 80-200

destination_port_range

String

Destination port range.

Value range: 1-65535

Format: 80-200

ethertype

String

IP address version of the mirrored traffic.

The value can be IPv4 or IPv6.

protocol

String

Protocol of the mirrored traffic.

The value can be TCP, UDP, ICMP, ICMPV6, or ALL.

action

String

Whether to accept or reject traffic.

The value can be accept or reject.

priority

Integer

Mirror filter rule priority.

Value range: 1-65535.

A smaller value indicates a higher priority.

created_at

String

Time when a traffic mirror filter rule is created.

updated_at

String

Time when a traffic mirror filter rule is updated.

Example Requests

Add a traffic mirror filter rule in the inbound direction to the traffic mirror filter with ID of 417d7317-6c17-4428-a0f3-997d3e2293a0 and with source CIDR of 192.168.0.0/24.

POST http://{endpoint}/v3/{project_id}/vpc/traffic-mirror-filter-rules

{
  "traffic_mirror_filter_rule" : {
    "traffic_mirror_filter_id" : "417d7317-6c17-4428-a0f3-997d3e2293a0",
    "ethertype" : "ipv4",
    "direction" : "ingress",
    "protocol" : "ICMP",
    "source_cidr_block" : "192.168.0.0/24",
    "action" : "accept",
    "priority" : 29
  }
}

Example Responses

Status code: 201

Created

{
  "request_id" : "8dec5453-1690-4378-a976-40ba5e6d62ff",
  "traffic_mirror_filter_rule" : {
    "created_at" : "2023-03-22T07:07:55.000+00:00",
    "updated_at" : "2023-03-22T07:07:55.000+00:00",
    "id" : "1be5f64b-49a1-427d-a49e-9619cfb0492c",
    "project_id" : "7365fcd452924e398ec4cc1fe39c0d12",
    "description" : "",
    "traffic_mirror_filter_id" : "417d7317-6c17-4428-a0f3-997d3e2293a0",
    "direction" : "ingress",
    "protocol" : "ICMP",
    "ethertype" : "IPv4",
    "source_cidr_block" : "192.168.0.0/24",
    "action" : "accept",
    "priority" : 29
  }
}

Status Codes

Status Code

Description

201

Created

Error Codes

See Error Codes.