CreateTrafficMirrorSession--私有网络-火山引擎

文档中心

立即注册

导航

CreateTrafficMirrorSession

最近更新时间：2024.10.21 19:52:31首次发布时间：2023.12.05 07:33:27

调用 CreateTrafficMirrorSession 接口，创建镜像会话。

接口说明

创建镜像会话后，流量镜像开始计费。若镜像源是辅助网卡，当辅助网卡从云服务器卸载，依然正常计费。
CreateTrafficMirrorSession为异步接口，即返回请求ID时，系统后台仍在创建。您可调用 DescribeTrafficMirrorSessions 查看镜像会话的状态，Creating表示创建中，Active 表示创建完成。

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	CreateTrafficMirrorSession	要执行的操作，取值为CreateTrafficMirrorFilter。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
TrafficMirrorSessionName	String	否	TM_Session_1	镜像会话的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短横线（-）。不填默认为镜像会话的ID。
Description	String	否	TM_Session_1_Description	镜像会话的描述信息。不填默认空字符串。长度限制为0~ 255个字符。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
NetworkInterfaceId	String	是	eni-bp1fgnh68xyz9****	镜像源的网卡ID。当前仅支持主网卡或已挂载在云服务器的辅助网卡。您可调用 DescribeNetworkInterfaces 查询满足条件的网卡。
TrafficMirrorTargetId	String	是	tmt-35bvae1r7rv283dy2w2ll****	镜像目的ID。您可以调用 DescribeTrafficMirrorTargets 接口，查询镜像目的的ID。
Priority	Integer	是	1	镜像会话的优先级，取值范围为1~32766。数字越小，优先级越高。同一账号在同一个地域创建的镜像会话优先级不能重复。
VirtualNetworkId	Integer	否	2	镜像会话VNI。用于镜像目标区分不同镜像会话的流量。取值范围：0~16777215。不指定则随机分配。
PacketLength	Integer	否	1450	镜像会话数据包大小。最小范围为64字节，建议设置范围为64～1450字节。默认为1500字节。若设置的数据包大小 ≤ 镜像源的MTU值或 > 1450时，部分报文会被截断并丢弃被截断的内容。为了保证报文不被截断，建议您遵从如下关系设置网卡的MTU值：镜像源的MTU值 ≤ 镜像会话设置的数据包大小 ≤ 镜像目标的MTU值 - 50，且镜像会话设置的数据包大小 ≤ 1450。
TrafficMirrorFilterId	String	是	tmf-bp1opxu1zkhn00123****	筛选条件的ID。您可以调用 DescribeTrafficMirrorFilters 接口，查询筛选条件的ID。
ProjectName	String	否	default	镜像会话所属项目的名称。不填默认加入default项目。
Tags.N.Key	String	否	Tags.1.Key=key1&Tags.2.Key=key2	用户标签的标签键。参数 - N：表示标签键的序号，取值范围：1～50。多个标签键之间用&分隔。不能以 `volc:`或`sys:`开头，包括任意大小写形式。长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。若标签键开头或结尾存在空格，系统会自动为其去除。说明同一资源的标签键不允许重复。
Tags.N.Value	String	否	Tags.1.Value=value1&Tags.2.Value=value2	用户标签的标签值。参数 - N：表示标签值的序号，取值范围：1～50。多个标签值之间用&分隔。长度取值范围为0～256字符，不填默认为空。允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。大小写敏感。若标签值开头或结尾存在空格，系统会自动为其去除。说明若传入该参数，则必须先传入`Tags.N.Key`。
ClientToken	String	否	123e4567-e89b-12d3-a456-42665544****	客户端Token，用于保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。仅支持ASCII字符，且不能超过64个字符。若不传入ClientToken，则此次API调用不进行幂等校验。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
TrafficMirrorSessionId	String	tms-j6cmls82xnc86vtpe****	镜像会话的ID。

请求示例

GET /?Action=CreateTrafficMirrorSession&Version=2020-04-01&TrafficMirrorSessionName=TM_Session_1&NetworkInterfaceId=eni-bp1fgnh68xyz9****&TrafficMirrorTargetId=tmt-35bvae1r7rv283dy2w2ll****&Priority=1&TrafficMirrorFilterId=tmf-bp1opxu1zkhn00123**** HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "CreateTrafficMirrorSession",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****"，
        "TrafficMirrorSessionId": "tms-j6cmls82xnc86vtpe****"
    }
}

错误码

公共错误码，请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	此幂等请求的参数与前一个请求中使用的参数不一致。
---	---	---	---
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
400	InvalidEni.InstanceMismatch	The specified elastic network interface is not attached to the specified instance.	指定的弹性网卡没有绑定到ECS实例。
400	InvalidEni.InvalidStatus	The specified elastic network interface is not in the correct status for the request.	指定的弹性网卡所处的状态无法响应该请求。
400	InvalidEni.InvalidType	The type of specified elastic network interface is illegal for the request.	指定类型的弹性网卡无法响应该请求。
400	InvalidInstanceSpecification.Malformed	The specified instance does not currently support traffic mirror.	指定的实例当前不支持流量镜像。
400	InvalidName.Malformed	The specified name is malformed.	指定的名称格式不合法。请修复名称格式后重试。
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	指定的名称格式不合法。名称长度不能超过128个字符。
400	InvalidPacketLength.Malformed	The specified MTU is malformed.	指定的MTU不合法。
400	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400	InvalidParameter.NetworkInterfaceId	The network interface must not be the source and the target of traffic mirror sessions at the same time.	网卡不能同时作为流量镜像会话的源和目的。
400	InvalidPriority.Malformed	The specified priority is malformed.	指定的优先级不合法。
400	InvalidTag.Disorder	The specified index order of tag is malformed.	指定标签的索引顺序参数格式不合法。
400	InvalidTagKey.Malformed	The specified parameter tag key is invalid.	标签键不合法。
400	InvalidTagValue.Malformed	The specified parameter tag value is invalid.	标签值不合法。
400	InvalidTrafficMirrorFilter.InvalidStatus	The specified traffic mirror filter is not in the correct status for the request.	指定的镜像流量筛选条件所处的状态无法响应该请求。
400	InvalidTrafficMirrorTarget.InvalidInstance	The specified traffic mirror target has an invalid instance for the request.	指定的流量镜像目的所关联实例无法响应该请求。
400	InvalidTrafficMirrorTarget.InvalidStatus	The specified traffic mirror target is not in the correct status for the request.	指定的镜像流量目的所处的状态无法响应该请求。
400	InvalidVirtualNetworkId.Malformed	The specified VNI is malformed.	指定的VNI不合法。
400	LimitExceeded.Tags	You've reached the limit on the number of tags that you can operate at one time.	已达到单次可操作标签数量的上限。
400	OrderError	Failed to create an order in one step.	创建订单并支付失败。
400	QuotaExceeded.TrafficMirrorFilterSession	You've reached the limit on the number of traffic mirror sessions per filter that you can create.	已达到每个筛选条件可关联镜像会话的数量上限。
400	QuotaExceeded.TrafficMirrorSession	You've reached the limit on the number of traffic mirror sessions that you can create.	已达到可创建镜像流量会话的数量上限。
400	QuotaExceeded.TrafficMirrorSourceSession	You've reached the limit on the number of traffic mirror sessions per source that you can create.	已达到每个镜像源可关联镜像会话的数量上限。
400	QuotaExceeded.TrafficMirrorTargetSession	You've reached the limit on the number of traffic mirror sessions per target that you can create.	已达到每个镜像目的可关联镜像会话的数量上限。
400	QuotaExceeded.TrafficMirrorTargetSource	You've reached the limit on the number of traffic mirror sources per target that you can create.	已达到每个镜像目的可关联镜像源的数量上限。
400	UnsupportedOperation	The request on the specified instance is denied due to the account in arrears status.	因账户处于欠费状态，对于该实例的操作请求被拒绝。
400	UnsupportedOperation	The request on the specified instance is denied due to the account balance and available vouchers are less than 100 yuan in total.	因账户余额及可用代金券共不足100元，对于该实例的操作请求被拒绝。
403	Forbidden	You are not authorized to perform operations on the specified elastic network interface. The specified elastic network interface is a service-managed elastic network interface.	无权限对指定弹性网卡进行操作。指定的弹性网卡为云产品托管的弹性网卡。
403	Forbidden.PurchaseLimited	The account is not authorized to purchase the resource.	此账户无权限购买资源。
404	InvalidEniId.NotFound	The specified elastic network interface does not exist.	指定的弹性网卡不存在。
404	InvalidNetworkInterfaceId.NotFound	The specified traffic mirror source network interface does not exist.	指定的镜像流量源不存在。
404	InvalidProject.NotFound	The specified Project does not exist.	指定的项目不存在。
404	InvalidTrafficMirrorFilter.NotFound	The specified traffic mirror filter does not exist.	指定的镜像流量筛选条件不存在。
404	InvalidTrafficMirrorTarget.NotFound	The specified traffic mirror target does not exist.	指定的镜像流量目的不存在。
409	InvalidTrafficMirrorSessionPriority.Conflict	The specified priority conflicts with another in your traffic mirror session.	指定的镜像流量会话与所属镜像流量会话下优先级冲突。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	幂等请求处理中。