调用CreateTrafficMirrorFilter接口创建流量镜像筛选条件。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateTrafficMirrorFilter

系统规定参数。取值:CreateTrafficMirrorFilter

TrafficMirrorFilterDescription String this is a filter.

流量镜像筛选条件的描述信息。

长度为2~256个字符,必须以字母或中文开头,但不能以http://https://开头。

TrafficMirrorFilterName String abc

流量镜像筛选条件的名称。

长度为2~128个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

ClientToken String 123e4567-e89b-12d3-a456-426655440000

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

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
DryRun Boolean false

是否只预检此次请求。取值:

  • true:发送检查请求,不会创建流量镜像筛选条件。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回2xx HTTP状态码并直接创建筛选条件。
RegionId String cn-hongkong

流量镜像的所属地域ID。

您可以通过调用DescribeRegions接口获取地域ID。关于流量镜像支持的地域,请参见流量镜像概述

IngressRules.N.Action String accept

入方向规则的采集策略。取值:

  • accept:采集网络流量。
  • drop:不采集网络流量。
IngressRules.N.SourceCidrBlock String 10.0.0.0/24

入方向规则网络流量的源地址网段。

IngressRules.N.Protocol String TCP

入方向需要镜像的网络流量使用的协议类型。取值:

  • ALL:所有协议。
  • ICMP:网络控制报文协议。
  • TCP:传输控制协议。
  • UDP:用户数据报协议。
IngressRules.N.DestinationPortRange String 80/120

入方向规则网络流量的目的端口范围。端口范围为1~65535,使用正斜线(/)隔开起始端口和终止端口,格式为1/20080/80

说明IngressRules.N.Protocol取值为ALLICMP时,该参数无需设置,表示不限制端口。
IngressRules.N.Priority Integer 1

入方向规则的优先级。数字越小,优先级越高。

其中N最大取值为10,即一个筛选条件最多可配置10条入方向规则。

IngressRules.N.DestinationCidrBlock String 10.0.0.0/24

入方向规则网络流量的目的地址网段。

IngressRules.N.SourcePortRange String 80/120

入方向规则网络流量的源端口范围。端口范围为1~65535,使用正斜线(/)隔开起始端口和终止端口,格式为1/20080/80

说明IngressRules.N.Protocol取值为ALLICMP时,该参数无需配置,表示不限制端口。
EgressRules.N.Action String accept

出方向规则的采集策略。取值:

  • accept:采集网络流量。
  • drop:不采集网络流量。
EgressRules.N.SourceCidrBlock String 10.0.0.0/24

出方向规则网络流量的源地址网段。

EgressRules.N.Protocol String TCP

出方向需要镜像的网络流量使用的协议类型。取值:

  • ALL:所有协议。
  • ICMP:网络控制报文协议。
  • TCP:传输控制协议。
  • UDP:用户数据报协议。
EgressRules.N.DestinationPortRange String 22/40

出方向规则网络流量的目的端口范围。端口范围为1~65535,使用正斜线(/)隔开起始端口和终止端口,格式为1/20080/80,其中-1/-1不能单独设置,代表不限制端口。

说明EgressRules.N.Protocol取值为ALLICMP时,该参数无需配置,表示不限制端口。
EgressRules.N.Priority Integer 1

出方向规则的优先级。数字越小,优先级越高。

其中N最大取值为10,即一个筛选条件最多可配置10条出方向规则。

EgressRules.N.DestinationCidrBlock String 10.0.0.0/24

出方向规则网络流量的目的地址网段。

EgressRules.N.SourcePortRange String 22/40

出方向规则网络流量的源端口范围。端口范围为1~65535,使用正斜线(/)隔开起始端口和终止端口,格式为1/20080/80,其中-1/-1不能单独设置,代表不限制端口。

说明EgressRules.N.Protocol取值为ALLICMP时,该参数无需配置,表示不限制端口。

返回数据

名称 类型 示例值 描述
TrafficMirrorFilterId String tmf-j6cmls82xnc86vtpe****

流量镜像筛选条件的实例ID。

RequestId String 28DB147D-217B-43E8-9E94-A3F6837DDC8A

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTrafficMirrorFilter
&TrafficMirrorFilterDescription=this is a filter.
&TrafficMirrorFilterName=abc
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&DryRun=false
&IngressRules=[{"Action":"accept","SourceCidrBlock":"10.0.0.0/24","Protocol":"TCP","DestinationPortRange":"80/120","Priority":1,"DestinationCidrBlock":"10.0.0.0/24","SourcePortRange":"80/120"}]
&EgressRules=[{"Action":"accept","SourceCidrBlock":"10.0.0.0/24","Protocol":"TCP","DestinationPortRange":"22/40","Priority":1,"DestinationCidrBlock":"10.0.0.0/24","SourcePortRange":"22/40"}]
&RegionId=cn-hongkong
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateTrafficMirrorFilterResponse>
    <TrafficMirrorFilterId>tmf-j6cmls82xnc86vtpe****</TrafficMirrorFilterId>
    <RequestId>28DB147D-217B-43E8-9E94-A3F6837DDC8A</RequestId>
</CreateTrafficMirrorFilterResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TrafficMirrorFilterId" : "tmf-j6cmls82xnc86vtpe****",
  "RequestId" : "28DB147D-217B-43E8-9E94-A3F6837DDC8A"
}

错误码

HttpCode 错误码 错误信息 描述
400 IncorrectBusinessStatus.TrafficMirror The business status of traffic mirror is incorrect. 流量镜像的商业状态不正确。
400 OptInRequired.TrafficMirror You need to subscribe to the traffic mirror service first. 未开通流量镜像服务。
400 QuotaExceeded.TrafficMirrorFilter The maximum number of traffic image filters is exceeded. 流量镜像筛选条件数量配额超限。
400 DuplicatedParam.Priority The specified priority conflicts with the existing priority. 指定的优先级参数与已有的优先级重复。
400 UnsupportedRegion The feature is not supported in current region. 当前地域不支持该功能。

访问错误中心查看更多错误码。