# 批量创建流量镜像筛选规则 - BatchCreateTrafficMirrorFilterRules #### 功能介绍 在单个流量镜像的筛选条件中批量添加入方向和出方向规则。 - 入方向规则：用来匹配镜像源接收到的流量。 - 出方向规则：用来匹配镜像源发送出去的流量。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-vpc/vpc_api00_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpc/vpc_permission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vpc:trafficMirrorFilterRules:create | Write | trafficMirrorFilter \* | - | - | - | | vpc:trafficMirrorFilterRules:create | Write | trafficMirrorFilterRule \* | - | - | - | #### URI POST /v3/{project_id}/vpc/traffic-mirror-filters/{traffic_mirror_filter_id}/traffic-mirror-filter-rules/batch-create 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 流量镜像筛选规则所属的项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-vpc/vpc_api_0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | traffic_mirror_filter_id | 是 | String | **参数解释**： 流量镜像筛选条件的资源ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | traffic_mirror_filter_rules | 是 | Array of [BatchCreateTrafficMirrorFilterRuleOption] objects | **参数解释**： 流量镜像筛选条件规则对象列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表3BatchCreateTrafficMirrorFilterRuleOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | description | 否 | String | **参数解释**： 流量镜像筛选规则的描述信息。 **约束限制**： 0-255个字符，不能包含"\<"和"\>"。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | direction | 是 | String | **参数解释**： 流量方向。 **约束限制**： 不涉及。 **取值范围**： - ingress：入方向。 - egress：出方向。 **默认取值**： 不涉及。 | | protocol | 是 | String | **参数解释**： 镜像流量支持的网络协议类型。 **约束限制**： 不涉及。 **取值范围**： - TCP：选择TCP协议，可以自定义源端口范围和目的端口范围。 - UDP：选择UDP协议，可以自定义源端口范围和目的端口范围。 - ICMP："IP类型"选择"IPv4"时，可选择ICMP协议，源端口范围和目的端口范围默认为全部端口。 - ICMPV6："IP类型"选择"IPv6"时，可选择ICMPV6协议，源端口范围和目的端口范围默认为全部端口。 - ALL：表示支持全部网络协议，源端口范围和目的端口范围默认为全部端口。 **默认取值**： 不涉及。 | | ethertype | 是 | String | **参数解释**： 镜像流量的地址协议版本。 **约束限制**： 不涉及。 **取值范围**： - IPv4。 - IPv6。 **默认取值**： 不涉及。 | | 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 | **参数解释**： 流量源端口范围。 **约束限制**： - 使用中划线(-)连接起始端口和结束端口，即"起始端口-结束端口"，结束端口取值应大于等于起始端口，例如22-23。 - 不填或者填写"1-65535"，表示全部端口。 **取值范围**： 1\~65535 **默认取值**： 不涉及。 | | destination_port_range | 否 | String | **参数解释**： 流量目的端口范围。 **约束限制**： - 使用中划线(-)连接起始端口和结束端口，即"起始端口-结束端口"，结束端口取值应大于等于起始端口，例如22-23。 - 不填或者填写"1-65535"，表示全部端口。 **取值范围**： 1\~65535 **默认取值**： 不涉及。 | | action | 是 | String | **参数解释**： 符合筛选条件的镜像流量的采集策略。 **约束限制**： 不涉及。 **取值范围**： - accept：采集，将镜像该流量到镜像目的。 - reject：不采集，将不会镜像该流量到镜像目的。 **默认取值**： 不涉及。 | | priority | 是 | Integer | **参数解释**： 镜像规则优先级。数字越小，优先级越高。 **约束限制**： 不涉及。 **取值范围**： 1\~65535 **默认取值**： 不涉及。 | #### 响应参数 **状态码：201** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | traffic_mirror_filter_rules | Array of [TrafficMirrorFilterRule] objects | **参数解释**： 流量镜像筛选规则列表的响应体。 **取值范围**： 不涉及。 | | request_id | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。 | 表5TrafficMirrorFilterRule | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 流量镜像筛选规则的资源ID。 **取值范围**： 不涉及。 | | project_id | String | **参数解释**： 流量镜像筛选规则所属的项目ID。 **取值范围**： 不涉及。 | | description | String | **参数解释**： 流量镜像筛选规则的描述信息。 **取值范围**： 不涉及。 | | 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 | | destination_port_range | String | **参数解释**： 流量镜像筛选规则的目的端口范围。 **取值范围**： 1\~65535 | | 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 | **参数解释**： 流量镜像筛选规则的创建时间。 **取值范围**： 不涉及。 | | updated_at | String | **参数解释**： 流量镜像筛选规则的更新时间。 **取值范围**： 不涉及。 | #### 请求示例 批量创建2条流量镜像筛选规则，规则为入方向，协议为ICMP。 ``` POST http://{endpoint}/v3/{project_id}/vpc/traffic-mirror-filters/{traffic_mirror_filter_id}/traffic-mirror-filter-rules/batch-create { "traffic_mirror_filter_rules" : [ { "ethertype" : "IPv4", "direction" : "ingress", "protocol" : "icmp", "source_cidr_block" : "192.168.0.0/24", "action" : "accept", "priority" : 29 }, { "ethertype" : "IPv4", "direction" : "ingress", "protocol" : "icmp", "source_cidr_block" : "192.168.21.0/24", "action" : "reject", "priority" : 10 } ] } ``` #### 响应示例 **状态码：201** ``` { "request_id" : "8dec5453-1690-4378-a976-40ba5e6d62ff", "traffic_mirror_filter_rules" : [ { "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, "type" : "eni", "created_at" : "2023-03-22T07:07:55.000+00:00", "updated_at" : "2023-03-22T07:07:55.000+00:00" }, { "id" : "4a97b166-ba05-01a9-b8fe-78af978d334b", "project_id" : "7365fcd452924e398ec4cc1fe39c0d12", "description" : "", "traffic_mirror_filter_id" : "417d7317-6c17-4428-a0f3-997d3e2293a0", "direction" : "ingress", "protocol" : "icmp", "ethertype" : "IPv4", "source_cidr_block" : "192.168.21.0/24", "action" : "reject", "priority" : 10, "type" : "eni", "created_at" : "2023-03-22T07:07:55.000+00:00", "updated_at" : "2023-03-22T07:07:55.000+00:00" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 201 | Created | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-vpc/vpc_api_0003.html)。