DescribeTrafficMirrors

Last updated:2026-02-04 14:11:42

DescribeTrafficMirrors

Last updated: 2026-02-04 14:11:42

1. API Description

Domain name for API request: vpc.intl.tencentcloudapi.com.

This API is used to query the information of a traffic mirroring instance.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeTrafficMirrors.
Version	Yes	String	Common Params. The value used for this API: 2017-03-12.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
TrafficMirrorIds.N	No	Array of String	Collection of traffic mirroring instance IDs.
Filters	No	Filter	Traffic mirroring query filtering and adjustment. vpc-id: VPC instance ID, for example: vpc-f49l6u0z. traffic-mirror-id: traffic mirroring instance ID. Traffic-Mirror-Name: traffic mirroring name. tag-key: filters according to the tag key.
Offset	No	Integer	Offset. Default value: 0.
Limit	No	Integer	Number of returns. Default value: 20. Maximum value: 100.

3. Output Parameters

Parameter Name	Type	Description
TrafficMirrorSet	Array of TrafficMirror	Traffic mirroring instance information.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying Traffic Mirroring Instance Information

This example shows you how to query traffic mirroring instance information.

Input Example

https://vpc.intl.tencentcloudapi.com/?Action=DescribeTrafficMirrors
&TrafficMirrorIds.0=&Filters.Name=&Filters.Values.0=
&<Common request parameters>

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InvalidParameter.Coexist	The parameters cannot be specified at the same time.
InvalidParameterValue.Malformed	Invalid input parameter format.
InvalidParameterValue.Range	The parameter value is not in the specified range.
ResourceNotFound	The resource does not exist.
UnsupportedOperation	Unsupported operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud