CheckTrafficMirror

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

CheckTrafficMirror

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

1. API Description

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

This API is used to check the collector and receiver for traffic mirroring (public IP address type).

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: CheckTrafficMirror.
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.
VpcId	Yes	String	Traffic mirroring VPC.
TrafficMirrorId	No	String	Traffic mirroring instance ID.
CollectorSources.N	No	Array of String	Collector IP address list for traffic mirroring.
SubnetId	No	String	Receiver subnet for traffic mirroring.
CollectorTarget.N	No	Array of TrafficMirrorTarget	Traffic mirroring collector.

3. Output Parameters

Parameter Name	Type	Description
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 Checking the Collector and Receiver of the Public IP Address Type for Traffic Mirroring

This example shows you how to check the collector and receiver of the public IP address type for traffic mirroring.

Input Example

https://vpc.intl.tencentcloudapi.com/?Action=CheckTrafficMirror
&VpcId=vpc-xxxx
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "7469d6ba-c0fa-4cc4-9ac7-e244a20cb8c0"
    }
}

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.DuplicatedLbTrafficMirrorCollectors	The current IP address has already been used in the traffic mirroring of another public IP address type.
InvalidParameter.UnsupportedLbTrafficMirrorAz	The region of the current public IP address does not support traffic collection.
InvalidParameterValue.DuplicatedLbTrafficMirrorCollectors	The current IP address has already been used in the traffic mirroring of another public IP address type.
InvalidParameterValue.Empty	Missing parameters.
InvalidParameterValue.InvalidLbTrafficMirrorReciverEndpoint	The receiver is neither an existing virtual machine IP address nor a routable IDC room IP address.
InvalidParameterValue.LimitExceeded	The parameter value exceeds the limit.
InvalidParameterValue.Malformed	Invalid input parameter format.
InvalidParameterValue.UnsupportedLbTrafficMirrorAz	The region of the current public IP address does not support traffic collection.
ResourceNotFound	The resource does not exist.
UnsupportedOperation.VpcMismatch	The resources are not in the same VPC.

Was this page helpful?

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

Yes

Feedback

tencent cloud