更新时间:2026-01-09 GMT+08:00

查询流量镜像筛选规则列表

功能介绍

当您的流量镜像筛选规则创建成功后,您可以通过该接口查询所有流量镜像筛选规则的信息,包括流量镜像筛选规则的源/目的地址、源/目的端口等。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

流量镜像筛选规则所属的项目ID。

取值范围:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

id

否

Array of strings

参数解释:

流量镜像筛选规则的资源ID,可以通过此字段精确过滤流量镜像筛选规则,支持传入多个ID过滤。

取值范围:

不涉及。

action

否

Array of strings

参数解释:

流量镜像筛选规则的策略,可以通过此字段过滤流量镜像筛选规则,支持传入多个策略过滤。

取值范围:

accept,reject

description

否

Array of strings

参数解释:

流量镜像筛选规则的描述信息,可以通过此字段过滤流量镜像筛选规则,支持传入多个描述信息进行过滤。

取值范围:

不涉及。

destination_cidr_block

否

Array of strings

参数解释:

流量镜像筛选规则的目的地址,可以通过此字段过滤流量镜像筛选规则,支持传入多个地址进行过滤。

取值范围:

不涉及。

destination_port_range

否

Array of strings

参数解释:

流量镜像筛选规则的目的端口范围,可以通过此字段过滤流量镜像筛选规则,支持传入多个端口范围进行过滤。

取值范围:

不涉及。

direction

否

Array of strings

参数解释:

流量镜像筛选规则的流量方向,可以通过此字段过滤流量镜像筛选规则,支持传入多个方向进行过滤。

取值范围:

  • ingress:入方向。

  • egress:出方向。

priority

否

Array of integers

参数解释:

流量镜像筛选规则的优先级,可以通过此字段过滤流量镜像筛选规则,支持传入多个优先级进行过滤。

取值范围:

1~65535

protocol

否

Array of strings

参数解释:

流量支持的网络协议类型,可以通过此字段过滤流量镜像筛选规则,支持传入多个协议类型进行过滤。

取值范围:

  • TCP:过滤出支持TCP协议的流量镜像筛选规则。

  • UDP:过滤出支持UDP协议的流量镜像筛选规则。

  • ICMP:过滤出支持ICMP协议的流量镜像筛选规则。

  • ICMPV6:过滤出支持ICMPV6协议的流量镜像筛选规则。

  • ALL:过滤出支持全部协议的流量镜像筛选规则。

source_cidr_block

否

Array of strings

参数解释:

流量镜像筛选规则的源地址,可以通过此字段过滤流量镜像筛选规则,支持传入多个地址进行过滤。

取值范围:

不涉及。

source_port_range

否

Array of strings

参数解释:

流量镜像筛选规则的源端口范围,可以通过此字段过滤流量镜像筛选规则,支持传入多个端口范围进行过滤。

取值范围:

不涉及。

traffic_mirror_filter_id

否

Array of strings

参数解释:

流量镜像筛选规则所在流量镜像筛选条件的ID,可以通过此字段过滤流量镜像筛选规则,支持传入多个ID进行过滤。

取值范围:

不涉及。

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

traffic_mirror_filter_rules

Array of TrafficMirrorFilterRule objects

参数解释:

查询流量镜像筛选规则列表的响应体。

取值范围:

不涉及。

page_info

PageInfo object

参数解释:

分页信息。

取值范围:

不涉及。

request_id

String

参数解释:

请求ID。

取值范围:

不涉及。

表4 TrafficMirrorFilterRule

参数

参数类型

描述

id

String

参数解释:

流量镜像筛选规则的资源ID。

取值范围:

不涉及。

project_id

String

参数解释:

流量镜像筛选规则所属的项目ID。

取值范围:

不涉及。

description

String

参数解释:

流量镜像筛选规则的描述信息。

取值范围:

0-255个字符,不能包含“<”和“>”。

traffic_mirror_filter_id

String

参数解释:

流量镜像筛选规则所在流量镜像筛选条件的ID。

取值范围:

不涉及。

direction

String

参数解释:

流量镜像筛选规则的流量方向。

取值范围:

  • ingress:入方向。

  • egress:出方向。

source_cidr_block

String

参数解释:

流量镜像筛选规则的源地址。

取值范围:

  • 单个IP地址:IP地址/掩码,单个IPv4地址示例为192.168.10.10/32,单个IPv6地址示例为2002:50::44/128。

  • IP网段:IP地址/掩码,IPv4网段示例为192.168.52.0/24,IPv6网段示例为2407:c080:802:469::/64。

  • 所有IP地址:0.0.0.0/0表示匹配所有IPv4地址,::/0表示匹配所有IPv6地址。

destination_cidr_block

String

参数解释:

流量镜像筛选规则的目的地址。

取值范围:

  • 单个IP地址:IP地址/掩码,单个IPv4地址示例为192.168.10.10/32,单个IPv6地址示例为2002:50::44/128。

  • IP网段:IP地址/掩码,IPv4网段示例为192.168.52.0/24,IPv6网段示例为2407:c080:802:469::/64。

  • 所有IP地址:0.0.0.0/0表示匹配所有IPv4地址,::/0表示匹配所有IPv6地址。

source_port_range

String

参数解释:

流量镜像筛选规则的源端口范围。

取值范围:

  • 端口取值范围是1~65535。

  • 使用中划线(-)连接起始端口和结束端口,即“起始端口-结束端口”,结束端口取值应大于等于起始端口,例如22-23。

destination_port_range

String

参数解释:

流量镜像筛选规则的目的端口范围。

取值范围:

  • 端口取值范围是1~65535。

  • 使用中划线(-)连接起始端口和结束端口,即“起始端口-结束端口”,结束端口取值应大于等于起始端口,例如22-23。

ethertype

String

参数解释:

流量支持的IP地址类型。

取值范围:

IPv4,IPv6

protocol

String

参数解释:

流量支持的网络协议类型。

取值范围:

  • TCP:选择TCP协议,可以自定义源端口范围和目的端口范围。

  • UDP:选择UDP协议,可以自定义源端口范围和目的端口范围。

  • ICMP:“IP类型”选择“IPv4”时,可选择ICMP协议,源端口范围和目的端口范围默认为全部端口。

  • ICMPV6:“IP类型”选择“IPv6”时,可选择ICMPV6协议,源端口范围和目的端口范围默认为全部端口。

  • ALL:表示支持全部网络协议,源端口范围和目的端口范围默认为全部端口。

action

String

参数解释:

流量镜像筛选规则的流量采集策略。

取值范围:

  • accept:采集。

  • reject:不采集。

priority

Integer

参数解释:

流量镜像筛选规则的优先级。

取值范围:

1~65535,数字越小,优先级越高。

created_at

String

参数解释:

流量镜像筛选规则的创建时间。

取值范围:

UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。

updated_at

String

参数解释:

流量镜像筛选规则的更新时间。

取值范围:

UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。

表5 PageInfo

参数

参数类型

描述

previous_marker

String

参数解释:

当前页的第一条记录。

取值范围:

不涉及。

current_count

Integer

参数解释:

当前页的资源总数。

取值范围:

不涉及。

next_marker

String

参数解释:

当前页的最后一条记录,最后一页时无next_marker字段。

取值范围:

不涉及。

请求示例

查询流量镜像筛选规则列表

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

响应示例

状态码:200

OK

{
  "request_id" : "38719a68-c7c1-4fe1-bf12-4bb049349174",
  "traffic_mirror_filter_rules" : [ {
    "created_at" : "2023-02-17T08:42:44.000+00:00",
    "updated_at" : "2023-02-17T08:42:44.000+00:00",
    "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",
    "action" : "accept",
    "priority" : 16
  } ],
  "page_info" : {
    "previous_marker" : "3daa97b5-ad58-477d-86a5-52b65257f94b",
    "current_count" : 1
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。