You need to enable JavaScript to run this app.
导航
CreateTrafficMirrorFilterRule
最近更新时间:2024.10.21 19:52:31首次发布时间:2023.12.05 07:33:27

调用 CreateTrafficMirrorFilterRule 接口,创建筛选规则。

请求参数

参数名称
类型
是否必选
示例值
描述
ActionStringCreateTrafficMirrorFilterRule要执行的操作,取值为CreateTrafficMirrorFilterRule。
VersionString2020-04-01API版本信息,当前版本为2020-04-01。

TrafficMirrorFilterId

String

tmf-bp1opxu1zkhn00123****

筛选条件的ID。
您可以调用 DescribeTrafficMirrorFilters 接口,查询筛选条件的ID。

TrafficDirection

String

ingress

流量的方向。取值如下:

  • ingress:入向规则。

  • egress:出向规则。

Priority

Integer

1

筛选规则的优先级,范围为1-1000。

  • 数值越小,优先级越高。默认为1,1为最高优先级。

  • 同一筛选条件同一方向的优先级唯一。

Policy

String

accept

流量采集策略。取值如下:

  • accept:允许。即当镜像源的流量匹配该规则时,复制该流量至镜像目标进行监控分析。

  • reject:拒绝。即当镜像源的流量匹配该规则时,不复制该流量,拒绝对该流量进行监控分析。

Protocol

String

TCP

流量的协议。取值如下:

  • all:含TCP、UDP、ICMP协议。

  • tcp:TCP协议。

  • udp:UDP协议。

  • icmp:ICMP协议。

SourceCidrBlockString10.0.0.0/24流量源网段。

SourcePortRange

String

1/50

流量源端口范围。

  • Protocol传入all或icmp时。

    • 无需传入本参数。

    • 默认取值-1/-1,表示不限制端口。

  • Protocol传入tcp或udp时。

    • 本参数为必选。

    • 取值范围1~65535。

    • 使用正斜线(/)隔开起始端口和终止端口,如1/50、80/80。

DestinationCidrBlockString10.0.0.0/24流量目的网段。

DestinationPortRange

String

1/50

流量目的端口范围。

  • Protocol传入all或icmp时。

    • 无需传入本参数。

    • 默认取值-1/-1,表示不限制端口。

  • Protocol传入tcp或udp时。

    • 本参数为必选。

    • 取值范围1~65535。

    • 使用正斜线(/)隔开起始端口和终止端口,如1/50、80/80。

Description

String

TM_FilterRule_1

筛选规则的描述。

  • 长度限制为0 ~ 255个字符。

  • 不填默认为空字符串。

  • 需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。

ClientToken

String

123e4567-e89b-12d3-a456-42665544****

客户端Token,用于保证请求幂等性。

  • 由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。

  • 仅支持ASCII字符,且不能超过64个字符。

  • 若不传入ClientToken,则此次API调用不进行幂等校验。

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。
TrafficMirrorFilterRuleIdstringtmr-j6cmls82xnc86vtpe****筛选规则的ID。

请求示例

GET /?Action=CreateTrafficMirrorFilterRule&Version=2020-04-01&TrafficMirrorFilterId=tmf-bp1opxu1zkhn00123****&TrafficDirection=ingress&Priority=1&Policy=accept&Protocol=tcp&SourceCidrBlock=0.0.0.0/0&SourcePortRange=1/50&DestinationCidrBlock=0.0.0.0/0&DestinationPortRange=1/50 HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "CreateTrafficMirrorFilterRule",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "TrafficMirrorFilterRuleId": "tmr-j6cmls82xnc86vtpe****"
    }
}

错误码

公共错误码,请参见 公共错误码 。

HttpCode
错误码
错误信息
描述
400IdempotentParameterMismatchArguments on this idempotent request are inconsistent with arguments used in previous request(s).此幂等请求的参数与前一个请求中使用的参数不一致。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400InvalidDescription.MalformedThe specified description is malformed. Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidDestinationCidrBlock.MalformedThe specified destination CIDR block is malformed. Currently only IPv4 is supported.指定的目的网段不合法,当前只支持IPv4。
400InvalidDestinationPortRange.MalformedThe specified destination port range is malformed.指定的目的端口范围不合法。
400InvalidParameter.ClientTokenMalformedThe specified parameter ClientToken is malformed.指定的参数ClientToken格式不合法,长度不能超过64个ASCII字符。
400InvalidPolicy.MalformedThe specified policy is malformed.指定的采集策略不合法。
400InvalidPriority.MalformedThe specified priority is malformed.指定的优先级不合法。
400InvalidProtocol.MalformedThe specified protocol is malformed.指定的协议不合法。
400InvalidSourceCidrBlock.DestinationCidrBlockMismatchThe specified source and destination CIDR blocks are in different ether types.指定的源网段和目的网段的以太网类型不匹配。
400InvalidSourceCidrBlock.MalformedThe specified source CIDR block is malformed. Currently only IPv4 is supported.指定的源网段不合法,当前只支持IPv4。
400InvalidSourceCidrBlock.ProtocolMismatchThe specified source CIDR block and protocol are mismatch.指定的源网段和协议不匹配。
400InvalidSourcePortRange.MalformedThe specified source port range is malformed.指定的源端口范围不合法。
400InvalidTrafficDirection.MalformedThe specified traffic direction is malformed.指定的流量方向不合法。
400QuotaExceeded.TrafficMirrorFilterRuleYou've reached the limit on the number of traffic mirror filter rules that you can create.已达到可创建镜像流量筛选规则的数量上限。
404InvalidTrafficMirrorFilter.NotFoundThe specified traffic mirror filter does not exist.指定的镜像流量筛选条件不存在。
409InvalidTrafficMirrorFilterRule.ConflictThe specified rule conflicts with another in your traffic mirror filter.指定的镜像流量筛选规则与所属镜像流量筛选条件下另一条规则冲突。
409InvalidTrafficMirrorFilterRulePriority.ConflictThe specified rule priority conflicts with another rule priority in your traffic mirror filter.指定的镜像流量筛选规则与所属镜像流量筛选条件下另一条规则优先级冲突。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.幂等请求处理中。