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

创建流量镜像筛选规则

功能介绍

创建流量镜像筛选规则

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

取值范围

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

traffic_mirror_filter_rule

CreateTrafficMirrorFilterRuleOption object

流量镜像筛选条件规则对象

表3 CreateTrafficMirrorFilterRuleOption

参数

是否必选

参数类型

描述

description

String

功能说明:流量镜像筛选规则的描述信息

取值范围:0-255个字符,不能包含“<”和“>”

traffic_mirror_filter_id

String

功能说明:流量镜像筛选条件ID

direction

String

功能说明:流量方向

取值范围:

ingress,入方向;

egress,出方向

protocol

String

功能说明:镜像流量的协议类型

取值范围:TCP、UDP、ICMP、ICMPV6、ALL

ethertype

String

功能说明:镜像流量的地址协议版本

取值范围:IPv4,IPv6

source_cidr_block

String

功能说明:镜像流量的源网段

destination_cidr_block

String

功能说明:镜像流量的目的网段

source_port_range

String

功能说明:流量源端口范围

取值范围:1~65535

格式:80-200

destination_port_range

String

功能说明:流量目的端口范围

取值范围:1~65535

格式:80-200

action

String

功能说明:镜像策略

取值范围:accept(采集)、reject(不采集)

priority

Integer

功能说明:镜像规则优先级

取值范围:1~65535,数字越小,优先级越高

响应参数

状态码:201

表4 响应Body参数

参数

参数类型

描述

traffic_mirror_filter_rule

TrafficMirrorFilterRule object

参数解释

查询流量镜像筛选规则详情的响应体。

取值范围

不涉及。

request_id

String

参数解释

请求ID。

取值范围

不涉及。

表5 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。

请求示例

创建一条流量镜像筛选规则,入方向,筛选条件ID为417d7317-6c17-4428-a0f3-997d3e2293a0,源cidr为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
  }
}

响应示例

状态码: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
  }
}

状态码

状态码

描述

201

Created

错误码

请参见错误码