1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(CreateTrafficMirror)用于创建流量镜像实例。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateTrafficMirror。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
VpcId | 是 | String | VPC实例ID。 示例值:vpc-39lpx32d |
TrafficMirrorName | 是 | String | 流量镜像名字。 示例值:demo |
TrafficMirrorDescribe | 否 | String | 流量镜像描述。 示例值:demo |
State | 否 | String | 流量镜像状态, 支持RUNNING/STOPED(vpc),RUNNING(公网IP),当采集vpc流量镜像时,此参数为必填。 示例值:RUNNING |
Direction | 否 | String | 流量镜像采集方向,支持EGRESS/INGRESS/ALL(vpc),ALL(公网IP)。 示例值:EGRESS |
CollectorSrcs.N | 否 | Array of String | 流量镜像的采集对象。 示例值:["vpc-39lpv32n"] |
NatId | 否 | String | 流量镜像过滤的natgw实例。 示例值:nat-qo7kugz0 |
CollectorNormalFilters.N | 否 | Array of TrafficMirrorFilter | 需要过滤的五元组规则。 |
CollectorTarget | 否 | TrafficMirrorTarget | 流量镜像的目的地址。 |
SubnetId | 否 | String | 流量镜像采集流量的发送端所属子网ID。 示例值:subnet-iamq13a |
Type | 否 | String | 创建的流量镜像的类型,支持VPC/PUBLICIP,默认为VPC类型。 示例值:VPC |
Tags.N | 否 | Array of Tag | 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]。 示例值:[{"Key": "city", "Value": "shanghai"}] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TrafficMirror | TrafficMirror | 流量镜像实例 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建流量镜像
创建流量镜像
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTrafficMirror
<公共请求参数>
{
"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"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter.Coexist | 参数不支持同时指定。 |
InvalidParameter.DuplicatedLbTrafficMirrorCollectors | 当前IP已在其他公网IP类型的流量镜像中使用。 |
InvalidParameter.UnsupportedLbTrafficMirrorAz | 当前公网IP所在的地区不支持流量采集。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.DuplicatedLbTrafficMirrorCollectors | 当前IP已在其他公网IP类型的流量镜像中使用。 |
InvalidParameterValue.DuplicatedLbTrafficMirrorReciverEndpoint | 当前接收端已在其他的公网IP类型的流量镜像中使用。 |
InvalidParameterValue.InvalidLbTrafficMirrorReciverEndpoint | 接收端不是一个存在的虚机IP也不是可路由的idc机房IP。 |
InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.MirrorLackTargetResource | 流量镜像target的内网带宽不足。 |
InvalidParameterValue.ObjectUseInTrafficMirror | 流量镜像采集对象已经被使用。 |
InvalidParameterValue.ObjectVpcNotCurrentVpc | 流量镜像采集的VPC不是当前VPCID。 |
InvalidParameterValue.TagDuplicateKey | 标签键重复。 |
InvalidParameterValue.TagDuplicateResourceType | 重复的标签资源类型。 |
InvalidParameterValue.TagInvalidKey | 标签键无效。 |
InvalidParameterValue.TagInvalidKeyLen | 标签键长度无效。 |
InvalidParameterValue.TagInvalidVal | 标签值无效。 |
InvalidParameterValue.TagKeyNotExists | 标签键不存在。 |
InvalidParameterValue.TagNotAllocatedQuota | 标签没有分配配额。 |
InvalidParameterValue.TagNotExisted | 该标签不存在。 |
InvalidParameterValue.TagNotSupportTag | 不支持的标签。 |
InvalidParameterValue.TagResourceFormatError | 标签资源格式错误。 |
InvalidParameterValue.TagTimestampExceeded | 标签时间戳超配。 |
InvalidParameterValue.TagValNotExists | 标签值不存在。 |
InvalidParameterValue.UnsupportedLbTrafficMirrorAz | 当前公网IP所在的地区不支持流量采集。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.TagKeyExceeded | 标签键已达到上限。 |
LimitExceeded.TagKeyPerResourceExceeded | 每个资源的标签键已达到上限。 |
LimitExceeded.TagNotEnoughQuota | 没有足够的标签配额。 |
LimitExceeded.TagQuota | 标签配额已满,无法创建资源。 |
LimitExceeded.TagQuotaExceeded | 标签配额已达到上限。 |
LimitExceeded.TagTagsExceeded | 标签键的数目已达到上限。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.Ipv6NotSupport | 不支持IPV6。 |
UnsupportedOperation.PublicClbNotSupport | 不支持公网CLB。 |
UnsupportedOperation.TagAllocate | 标签正在分配中。 |
UnsupportedOperation.TagFree | 标签正在释放中。 |
UnsupportedOperation.TagNotPermit | 标签没有权限。 |
UnsupportedOperation.TagSystemReservedTagKey | 不支持使用系统预留的标签键。 |
UnsupportedOperation.TrafficMirrorNotSupportClb | 流量镜像不支持目标Clb。 |
UnsupportedOperation.TrafficMirrorNotSupportSameSrcTarget | 流量镜像源、目的不可同端。 |