Release Notes
Announcements
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.
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"}]. |
| 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. |
This example shows you how to create traffic mirroring.
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"
]
}{
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
피드백