tencent cloud

私有网络

动态与公告
产品动态
产品公告
腾讯云网络总览
产品简介
产品概述
产品优势
应用场景
基本概念
配额限制
购买指南
计费概述
欠费说明
快速入门
网络规划
VPC 连接
快速搭建 IPv4 私有网络
操作指南
网络拓扑
网络性能大盘
私有网络
子网
路由表
弹性公网 IP
高可用虚拟 IP
弹性网卡
共享带宽包
网络连接
安全管理
诊断工具
告警与监控
实践教程
查看单地域按流量计费的总带宽
基础网络迁移至私有网络
安全组变更最佳实践
配置云服务器为公网网关
用 HAVIP+Keepalived 搭建高可用主备集群
通过专线接入和 VPN 连接实现混合云主备冗余通信
通过云联网和 VPN 连接实现混合云主备冗余通信
通过 EIP 实现云服务器访问 Internet
故障处理
无法删除 VPC 或子网
使用云联网打通两个 VPC 后网络不通
同 VPC 下两台云服务器无法 ping 通
API 文档
History
Introduction
API Category
Making API Requests
VPC APIs
Route Table APIs
Elastic Public IP APIs
Elastic IPv6 APIs
Highly Available Virtual IP APIs
ENI APIs
Bandwidth Package APIs
NAT Gateway APIs
Direct Connect Gateway APIs
Cloud Connect Network APIs
Network ACL APIs
Network Parameter Template APIs
Network Detection-Related APIs
Flow Log APIs
Gateway Traffic Monitor APIs
Private Link APIs
Traffic Mirroring APIs
Other APIs
Subnet APIs
VPN Gateway APIs
Security Group APIs
Snapshot Policy APIs
Error Codes
Data Types
常见问题
通用类
连接类
安全类
联系我们
词汇表

CreateTrafficMirror

PDF
聚焦模式
字号
最后更新时间: 2026-02-04 14:11:45

1. API Description

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

This API is used to create 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: CreateTrafficMirror.
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 VPC instance ID.
TrafficMirrorName Yes String Traffic mirroring name.
TrafficMirrorDescribe No String Traffic mirroring description.
State No String Traffic mirroring status. Valid values: RUNNING/STOPED (VPC) and RUNNING (public IP address). It is required when VPC traffic mirroring is collected.
Direction No String Traffic mirroring collection direction. Valid values: EGRESS/INGRESS/ALL (VPC) and ALL (public IP address).
CollectorSrcs.N No Array of String Traffic mirroring collection object.
NatId No String NAT gateway instance filtered by traffic mirroring.
CollectorNormalFilters.N No Array of TrafficMirrorFilter Five tuple rule to be filtered.
CollectorTarget No TrafficMirrorTarget Traffic mirroring destination address.
SubnetId No String Subnet ID of the sender of the traffic mirroring collection traffic.
Type No String Created traffic mirroring type. Valid values: VPC and PUBLICIP. Default value: VPC.
Tags.N No Array of Tag Specifies the list of bound tags. For example, [{"Key": "city", "Value": "shanghai"}].

3. Output Parameters

Parameter Name Type Description
TrafficMirror TrafficMirror Traffic mirroring instance.
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 Creating Traffic Mirroring

This example shows you how to create traffic mirroring.

Input Example

POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTrafficMirror
<Common request parameters>

{
    "Direction": "EGRESS",
    "NatId": "nat-qo7kugz0",
    "TrafficMirrorName": "demo",
    "State": "RUNNING",
    "VpcId": "vpc-39lpx32d",
    "CollectorTarget": {
        "AlgHash": "FIVE_TUPLE_FLOW",
        "TargetIps": [
            "172.16.16.10"
        ]
    },
    "CollectorSrcs": [
        "eni-39lpv32n"
    ]
}

Output Example

{
    "Response": {
        "TrafficMirror": {
            "VpcId": "vpc-fo8nfm00",
            "TrafficMirrorId": "imgf-ewrpvb00",
            "TrafficMirrorName": "UpdateTrafficMirrorDirection_tUhhZ7Jj",
            "TrafficMirrorDescribe": "",
            "State": "RUNNING",
            "Direction": "EGRESS",
            "CollectorSrcs": [
                "eni-4qq71jmz"
            ],
            "NatId": "",
            "CollectorNormalFilters": [],
            "CollectorTarget": {
                "AlgHash": "ENI",
                "TargetType": "IP",
                "TargetIps": [
                    "10.0.0.0"
                ],
                "TargetEndPoints": []
            },
            "CreateTime": "0000-00-00 00:00:00"
        },
        "RequestId": "941e5605-e17c-45b8-bd80-031386e29559"
    }
}

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

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.
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 The parameter value is invalid.
InvalidParameterValue.DuplicatedLbTrafficMirrorCollectors The current IP address has already been used in the traffic mirroring of another public IP address type.
InvalidParameterValue.DuplicatedLbTrafficMirrorReciverEndpoint The current receiver has already been used in the traffic mirroring of another public IP address type.
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.MirrorLackTargetResource The private network bandwidth for the traffic mirroring target is insufficient.
InvalidParameterValue.ObjectUseInTrafficMirror The traffic mirroring collection object has already been used.
InvalidParameterValue.ObjectVpcNotCurrentVpc The VPC for traffic mirroring collection is not the current VPC ID.
InvalidParameterValue.TagDuplicateKey Duplicate tag keys.
InvalidParameterValue.TagDuplicateResourceType Duplicate tag resource type.
InvalidParameterValue.TagInvalidKey Invalid tag key.
InvalidParameterValue.TagInvalidKeyLen Invalid tag key length.
InvalidParameterValue.TagInvalidVal Invalid tag key.
InvalidParameterValue.TagKeyNotExists The tag key does not exist.
InvalidParameterValue.TagNotAllocatedQuota Tags are not assigned quotas.
InvalidParameterValue.TagNotExisted The Tag does not exist.
InvalidParameterValue.TagNotSupportTag Unsupported tag.
InvalidParameterValue.TagResourceFormatError Tag resource format error.
InvalidParameterValue.TagTimestampExceeded Exceeded the quota of tag timestamp.
InvalidParameterValue.TagValNotExists The tag value does not exist.
InvalidParameterValue.UnsupportedLbTrafficMirrorAz The region of the current public IP address does not support traffic collection.
LimitExceeded Quota limit is reached.
LimitExceeded.TagKeyExceeded Reached the upper limit of tag keys.
LimitExceeded.TagKeyPerResourceExceeded Reached the upper limit of tags keys per resource.
LimitExceeded.TagNotEnoughQuota Insufficient tag quota.
LimitExceeded.TagQuota Exceeded the tag quota. Unable to create resources.
LimitExceeded.TagQuotaExceeded Reached the upper limit of tag quota.
LimitExceeded.TagTagsExceeded Reached the number limit of tag keys.
ResourceNotFound The resource does not exist.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.Ipv6NotSupport IPv6 is not supported.
UnsupportedOperation.PublicClbNotSupport Public CLBs are not supported.
UnsupportedOperation.TagAllocate Tags are being assigned.
UnsupportedOperation.TagFree Tags are being released.
UnsupportedOperation.TagNotPermit Unauthorized for this tag.
UnsupportedOperation.TagSystemReservedTagKey The specified tag key is reserved for system usage.
UnsupportedOperation.TrafficMirrorNotSupportClb Traffic mirroring does not support the target CLB.
UnsupportedOperation.TrafficMirrorNotSupportSameSrcTarget The collector and receiver for traffic mirroring cannot be the same.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈