Querying Traffic Mirror Filter Rules

Function

This API is used to query traffic mirror filter rules.

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
action	No	String	Filter by action.
description	No	String	Filter by description.
destination_cidr_block	No	String	Filter by destination CIDR block.
destination_port_range	No	String	Filter by destination port range.
direction	No	String	Filter by direction.
id	No	String	Filter or sort by ID.
priority	No	String	Filter by priority.
protocol	No	String	Filter by protocol.
source_cidr_block	No	String	Filter by source CIDR block.
source_port_range	No	String	Filter by source port range.
traffic_mirror_filter_id	No	String	Filter by traffic mirror filter ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
traffic_mirror_filter_rules	Array of TrafficMirrorFilterRule objects	Traffic mirror filter rules
page_info	PageInfo object	Pagination information
request_id	String	Request ID

**Table 4** 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

**Table 5** PageInfo
Parameter	Type	Description
previous_marker	String	First record on the current page
current_count	Integer	Total number of records on the current page
next_marker	String	Last record on the current page. This parameter does not exist if the page is the last one.

Example Request

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

Example Response

Status code: 200

{
  "request_id" : "38719a68-c7c1-4fe1-bf12-4bb049349174",
  "traffic_mirror_filter_rules" : [ {
    "created_at" : "2023-02-17T08:42:44Z",
    "updated_at" : "2023-02-17T08:42:44Z",
    "id" : "3daa97b5-ad58-477d-86a5-52b65257f94b",
    "project_id" : "7365fcd452924e398ec4cc1fe39c0d12",
    "description" : "",
    "traffic_mirror_filter_id" : "b765ba87-c0b4-4f1a-9ec3-d5b1d1ddb137",
    "direction" : "ingress",
    "protocol" : "ICMPV6",
    "ethertype" : "IPv4",
    "source_cidr_block" : null,
    "destination_cidr_block" : null,
    "source_port_range" : null,
    "destination_port_range" : null,
    "action" : "accept",
    "priority" : 16
  } ],
  "page_info" : {
    "previous_marker" : "3daa97b5-ad58-477d-86a5-52b65257f94b",
    "current_count" : 1
  }
}