私有网络用户查询流量镜像

1. 接口描述

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

本接口（DescribeTrafficMirrors）用于查询流量镜像实例信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTrafficMirrors。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
TrafficMirrorIds.N	否	Array of String	流量镜像实例ID集合示例值：imgf-cvfp7xo8
Filters	否	Filter	流量镜像查询过滤调节。 vpc-id ：VPC实例ID，例如：vpc-f49l6u0z。 traffic-mirror-id：流量镜像实例ID。 traffic-mirror-name：流量镜像名称。 tag-key ：按照标签键进行过滤。
Offset	否	Integer	偏移量，默认为0。示例值：0
Limit	否	Integer	返回数量，默认为20，最大值为100。示例值：20

3. 输出参数

参数名称	类型	描述
TrafficMirrorSet	Array of TrafficMirror	流量镜像实例信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询流量镜像实例信息

查询流量镜像实例信息

输入示例

https://vpc.tencentcloudapi.com/?Action=DescribeTrafficMirrors
&TrafficMirrorIds.0=&Filters.Name=&Filters.Values.0=
&<公共请求参数>

输出示例

{
    "Response": {
        "TrafficMirrorSet": [
            {
                "VpcId": "vpc-dh0wcvhp",
                "TrafficMirrorId": "imgf-dh0wcvhp",
                "TrafficMirrorName": "demo",
                "TrafficMirrorDescribe": "demo",
                "State": "RUNNING",
                "Direction": "INGRESS",
                "CollectorSrcs": [
                    "eni-dh0wcvhp"
                ],
                "NatId": "",
                "CollectorNormalFilters": [
                    {
                        "SrcNet": "10.0.0.0/24",
                        "DstNet": "192.168.0.0/24",
                        "SrcPort": "5000",
                        "DstPort": "3456",
                        "Protocol": "TCP"
                    }
                ],
                "CollectorTarget": {
                    "TargetIps": [
                        "172.16.0.3"
                    ],
                    "AlgHash": "ENI",
                    "TargetEndPoints": [],
                    "TargetType": "ENI"
                },
                "CreateTime": "2021-08-09 15:44:30",
                "Type": "VPC",
                "SubnetId": "subnet-dh0wcvhp",
                "TargetInfo": [
                    {
                        "TargetId": "eni-dh0wcvhp",
                        "TargetName": "demo"
                    }
                ]
            }
        ],
        "RequestId": "404428db-f850-40c2-803d-0aae49aba43a"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidParameter.Coexist	参数不支持同时指定。
InvalidParameterValue.Malformed	入参格式不合法。
InvalidParameterValue.Range	参数值不在指定范围。
ResourceNotFound	资源不存在。
UnsupportedOperation	操作不支持。

用户查询流量镜像

本页目录：