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

Updating a Traffic Mirror Filter Rule

Function

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

Debugging

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

URI

PUT /v3/{project_id}/vpc/traffic-mirror-filter-rules/{traffic_mirror_filter_rule_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_filter_rule_id

Yes

String

Traffic mirror filter rule ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

traffic_mirror_filter_rule

Yes

UpdateTrafficMirrorFilterRuleOption object

Traffic mirror filter rule.

Table 3 UpdateTrafficMirrorFilterRuleOption

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

protocol

No

String

Protocol of the mirrored traffic.

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

ethertype

No

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

priority

No

Integer

Mirror filter rule priority.

Value range: 1-65535.

A smaller value indicates a higher priority.

action

No

String

Whether to accept or reject traffic.

The value can be accept or reject.

Response Parameters

Status code: 200

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

Change action of the traffic mirror filter rule whose ID is 7c12805a-1b8d-40b5-ab23-a8fac480f2ec to reject.

PUT http://{endpoint}/v3/{project_id}/vpc/traffic-mirror-filter-rules/7c12805a-1b8d-40b5-ab23-a8fac480f2ec

{
  "traffic_mirror_filter_rule" : {
    "source_port_range" : "80-90",
    "destination_cidr_block" : "192.168.1.0/24",
    "source_cidr_block" : "10.0.0.0/8",
    "action" : "reject"
  }
}

Example Responses

Status code: 200

OK

{
  "request_id" : "197e0ed1-f59f-473b-9363-74666a7d3710",
  "traffic_mirror_filter_rule" : {
    "created_at" : "2023-03-09T13:14:47.000+00:00",
    "updated_at" : "2023-03-09T13:16:43.000+00:00",
    "id" : "7c12805a-1b8d-40b5-ab23-a8fac480f2ec",
    "project_id" : "7365fcd452924e398ec4cc1fe39c0d12",
    "description" : "",
    "traffic_mirror_filter_id" : "417d7317-6c17-4428-a0f3-997d3e2293a0",
    "direction" : "ingress",
    "protocol" : "ICMP",
    "ethertype" : "IPv4",
    "source_cidr_block" : "80-90",
    "destination_cidr_block" : "192.168.1.0/24",
    "source_port_range" : "10.0.0.0/8",
    "action" : "reject",
    "priority" : 23
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.