查询流量镜像过滤规则。

最近更新时间:2026-04-09 03:51:57

我的收藏

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

查询流量镜像五元组过滤规则。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTrafficMirrorFilterRules。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
TrafficMirrorId String 流量镜像唯一ID
示例值:imgf-jfzb00ia
TrafficMirrorFilterRuleIds.N Array of String 流量镜像出站、入站过滤唯一ID列表。
示例值:["tmfi-qfhrb7yj" , "tmfi-qghouehx"]
Filters.N Array of Filter
  • traffic-mirror-filter-rule-id - String - (过滤条件) 流量镜像过滤规则,形如:tmfi-qfhrb7yj。
  • action - String - (过滤条件)策略, 支持类型: ACCEPT, DROP。
  • description - String - (过滤条件)描述。
  • direction - String - (过滤条件)方向, 支持类型:INGRESS, EGRESS。
  • Offset Integer 偏移量。
    示例值:0
    Limit Integer 请求对象个数。
    示例值:10

    3. 输出参数

    参数名称 类型 描述
    TrafficMirrorId String 流量镜像实例唯一ID。
    示例值:imgf-jfzb00ia
    IngressFilterRules Array of TrafficMirrorFilter 流量镜像入站过滤规则。
    EgressFilterRules Array of TrafficMirrorFilter 流量镜像出站过滤规则。
    TotalCount Integer 符合条件的实例数量。分页查询的时候,如果IngressFilterRules的长度加上IngressFilterRules的长度,小于limit的时候表示已经查询完毕。
    示例值:10
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询流量镜像过滤规则

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeTrafficMirrorFilterRules
    <公共请求参数>
    
    {
        "TrafficMirrorId": "imgf-9ryixdn6",
        "TrafficMirrorFilterRuleIds": [
            "tmfi-bbc6a8cv"
        ]
    }

    输出示例

    {
        "Response": {
            "EgressFilterRules": [
                {
                    "Action": "DROP",
                    "CreatedTime": "2026-03-30 20:50:13",
                    "Description": "rule_1",
                    "DstNet": "10.0.0.0/16",
                    "DstPort": "2000-3000",
                    "Priority": 1,
                    "Protocol": "TCP",
                    "SrcNet": "192.168.0.0/16",
                    "SrcPort": "2000-3000",
                    "TrafficMirrorFilterRuleId": "tmfi-bbc6a8cv"
                }
            ],
            "IngressFilterRules": [
                {
                    "Action": "ACCEPT",
                    "CreatedTime": "2026-03-30 20:50:13",
                    "Description": "rule_1",
                    "DstNet": "10.0.0.0/16",
                    "DstPort": "1000-2000",
                    "Priority": 1,
                    "Protocol": "TCP",
                    "SrcNet": "192.168.0.0/16",
                    "SrcPort": "1000-2000",
                    "TrafficMirrorFilterRuleId": "tmfi-7gk0gtdz"
                }
            ],
            "TotalCount": 2,
            "TrafficMirrorId": "imgf-9ryixdn6",
            "RequestId": "8984d5f4-72c1-4eae-9cc9-7dc2c346316d"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。
    LimitExceeded 超过配额限制。
    LimitExceeded.ActionLimited 接口请求次数超过限频。
    MissingParameter 缺少参数错误。
    ResourceNotFound 资源不存在。
    UnsupportedOperation 操作不支持。