文档

CreateTrafficMirrorFilterRules - 创建流量镜像入方向或出方向规则

更新时间:

调用CreateTrafficMirrorFilterRules接口创建流量镜像入方向或出方向规则。

接口说明

  • CreateTrafficMirrorFilterRules 接口属于异步接口,即系统返回一个实例 ID,但该流量镜像入方向或出方向规则尚未创建成功,系统后台的创建任务仍在进行。您可以调用 ListTrafficMirrorFilters 查询流量镜像入方向或出方向规则的创建状态:
    • 当流量镜像入方向或出方向规则处于 Creating 状态时,表示流量镜像入方向或出方向规则正在创建中。
    • 当流量镜像入方向或出方向规则处于 Created 状态时,表示流量镜像入方向或出方向规则创建完成。
  • CreateTrafficMirrorFilterRules 接口不支持在同一个流量镜像筛选条件下并发创建流量镜像入方向或出方向规则。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:CreateTrafficMirrorFilterRulesWrite
  • TrafficMirrorFilter
    acs:vpc:{#regionId}:{#accountId}:trafficmirrorfilter/{#TrafficMirrorFilterId}

请求参数

名称类型必填描述示例值
TrafficMirrorFilterIdstring

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

tmf-j6cmls82xnc86vtpe****
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
123e4567-e89b-12d3-a456-426655440000
DryRunboolean

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

  • true:发送检查请求,不会创建入方向或出方向规则。检查项包括是否填写了必需参数、请求格式和限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后直接创建入方向或出方向规则。

false
IngressRulesobject []

入方向规则的详细信息。

Actionstring

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

  • accept:采集网络流量。
  • drop:不采集网络流量。
accept
SourceCidrBlockstring

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

10.0.0.0/24
Protocolstring

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

  • ALL:所有协议。
  • ICMP:网络控制报文协议。
  • TCP:传输控制协议。
  • UDP:用户数据报协议。
TCP
DestinationPortRangestring

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

说明 IngressRules.N.Protocol取值为 ALLICMP 时,该参数无需设置,表示不限制端口。
80/120
Priorityinteger

入方向规则的优先级。数字越小,优先级越高。其中 N 最大取值为 10,即一个筛选条件最多可配置 10 条入方向规则。

1
DestinationCidrBlockstring

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

10.0.0.0/24
SourcePortRangestring

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

说明 IngressRules.N.Protocol取值为 ALLICMP 时,该参数无需设置,表示不限制端口。
80/120
EgressRulesobject []

出方向规则的详细信息。

Actionstring

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

  • accept:采集网络流量。
  • drop:不采集网络流量。
accept
SourceCidrBlockstring

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

10.0.0.0/24
Protocolstring

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

  • ALL:所有协议。
  • ICMP:网络控制报文协议。
  • TCP:传输控制协议。
  • UDP:用户数据报协议。
TCP
DestinationPortRangestring

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

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

出方向规则的优先级。数字越小,优先级越高。其中 N 最大取值为 10,即一个筛选条件最多可配置 10 条出方向规则。

1
DestinationCidrBlockstring

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

10.0.0.0/24
SourcePortRangestring

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

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

流量镜像的所属地域 ID。

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

cn-hongkong

返回参数

名称类型描述示例值
object

详细信息。

RequestIdstring

请求 ID。

07F272E2-6AD5-433A-8207-A607C76F1676
IngressRulesobject []

入方向规则列表。

InstanceIdstring

入方向规则的实例 ID。

tmr-j6c6rtallo51ouzv3****
EgressRulesobject []

出方向规则列表。

InstanceIdstring

出方向规则的实例 ID。

tmr-j6cok23ugp53eeib5****

示例

正常返回示例

JSON格式

{
  "RequestId": "07F272E2-6AD5-433A-8207-A607C76F1676",
  "IngressRules": [
    {
      "InstanceId": "tmr-j6c6rtallo51ouzv3****"
    }
  ],
  "EgressRules": [
    {
      "InstanceId": "tmr-j6cok23ugp53eeib5****"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ResourceNotFound.TrafficMirrorFilterThe specified resource of traffic mirror filter is not found.指定的流量镜像筛选条件不存在。
400IncorrectStatus.TrafficMirrorFilterThe status of traffic mirror filter is incorrect.流量镜像筛选条件的状态不正确。
400IncorrectStatus.TrafficMirrorSessionThe status of traffic mirror session is incorrect.流量镜像会话状态不正确。
400QuotaExceeded.TrafficMirrorRulesPerFilterThe quota of the number of traffic mirror rules per filter is exceeded.单个流量镜像筛选条件所关联的筛选规则数量配额超限。
400DuplicatedParam.PriorityThe specified priority conflicts with the existing priority.指定的优先级参数与已有的优先级重复。
400UnsupportedRegionThe feature is not supported in current region.当前地域不支持该功能。
400IllegalParam.CidrBlockThe specified CidrBlock is illegal.CidrBlock参数非法。

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

变更历史

变更时间变更内容概要操作
2023-07-20OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈