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

文档中心

立即注册

导航

DescribeTrafficMirrorSessions

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

调用 DescribeTrafficMirrorSessions 接口，查询满足指定条件的镜像会话。

接口说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的镜像会话，若没有符合条件的镜像会话，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有镜像会话。

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeTrafficMirrorSessions	要执行的操作，取值为DescribeTrafficMirrorSessions。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
TrafficMirrorSessionNames.N	String	否	TrafficMirrorSessionNames.1=TM_Session_1&TrafficMirrorSessionNames.2=TM_Session_2	镜像会话的名称。
TrafficMirrorSessionIds.N	String	否	TrafficMirrorSessionIds.1=tms-j6cmls82xnc86vtpe**&TrafficMirrorSessionIds.1=tms-j6cmls82xnc868888**	镜像会话的ID。参数 - N：表示镜像会话ID的序号，单次调用数量上限为100个。多个镜像会话ID之间用&分隔。
NetworkInterfaceId	String	否	eni-bp1fgnh68xyz9****	镜像源网卡的ID。您可调用 DescribeNetworkInterfaces 查询满足条件的网卡。
TrafficMirrorTargetId	String	否	tmt-35bvae1r7rv283dy2w2ll****	镜像目的的ID。您可以调用 DeleteTrafficMirrorTarget 接口，查询镜像目的的ID。
TrafficMirrorFilterId	String	否	tmf-bp1opxu1zkhn00123****	筛选条件的ID。您可以调用 DescribeTrafficMirrorFilters 接口，查询筛选条件的ID。
VirtualNetworkId	Integer	否	2	镜像会话VNI。
PacketLength	Integer	否	9600	镜像会话数据包大小。
Priority	Integer	否	1	镜像会话的优先级。
ProjectName	String	否	default	镜像会话所属的项目。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3	标签的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的镜像会话。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1	标签的标签值。第一个N：表示标签键的序号。第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的镜像会话。多个标签值之间用&分隔。说明若传入该参数，则必须先传入`TagFilters.N.Key`。传入空字符串时，表示查询标签值为空的镜像会话。
NextToken	String	否	caeba0bbb2be03f84eb48b699f0a****	分页查询凭证，用于标记分页的位置。不填则从头开始查询。传入之前调用本API返回的`NextToken`，则从该次API调用标记分页的位置往后开始查询。
MaxResults	Integer	否	50	查询的数量，默认为 10，最大为100。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
NextToken	String	caeba0bbb2be03f84eb48b699f0a****	本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。
TrafficMirrorSessions	Array of TrafficMirrorSession	-	TrafficMirrorSessions的详细信息。具体请参见下表“TrafficMirrorSession结构”。

TrafficMirrorSession结构

参数名称	类型	示例值	描述
TrafficMirrorSessionId	String	tms-j6cmls82xnc86vtpe****	镜像会话的ID。
TrafficMirrorTargetId	String	tmt-35bvae1r7rv283dy2w2ll****	镜像目的的ID。
TrafficMirrorFilterId	String	tmf-bp1opxu1zkhn00123****	筛选条件的ID。
TrafficMirrorSourceIds	Array	["eni-35bvae1r7rv283dy2w2ll****"]	镜像源网卡列表。当前一个镜像会话仅支持关联一个镜像源。
Priority	Integer	1	镜像会话优先级。
PacketLength	Integer	9600	镜像会话数据包大小。
TrafficMirrorSessionName	String	TM_Session_1	镜像会话名称。
Description	String	TM_Session_1_Description	镜像会话的描述。
Status	String	Active	镜像会话状态。 Creating ：创建中。 Deleting ：删除中。 Pending ：修改中。 Active ：可用。 Inactive ：已关停。
BusinessStatus	String	Normal	镜像会话计费状态。 Normal：正常。 FinancialLocked：被锁定。
LockReason	String	Financial	锁定原因。 financial：因欠费被锁定。 unlock：欠费关停后充值恢复过程中。
VirtualNetworkId	Integer	2	镜像会话VNI。
ProjectName	String	default	镜像会话所属项目的名称。
Tags	Array of Struct	-	镜像会话的标签信息。具体请参见下表“Tag结构”。

Tag结构

参数名称	类型	示例值	描述
Key	String	k1	标签的标签键。
Value	String	v1	标签的标签值。

请求示例

GET /?Action=DescribeTrafficMirrorSessions&Version=2020-04-01&TrafficMirrorSessionIds.1=tms-j6cmls82xnc86vtpe****&TrafficMirrorSessionIds.1=tms-j6cmls82xnc868888**** HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeTrafficMirrorSessions",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "TrafficMirrorSession": [
            {
                "TrafficMirrorSessionId": "tms-j6cmls82xnc86vtpe****",
                "TrafficMirrorTargetId": "tmt-35bvae1r7rv283dy2w2ll****",
                "TrafficMirrorFilterId": "tmf-bp1opxu1zkhn00123****",
                "TrafficMirrorSourceIds": [
                    "eni-35bvae1r7rv283dy2w2ll****",
                ],
                "Priority": 1,
                "PacketLength": 9600,
                "AggregationInterval": 10,
                "TrafficMirrorSessionName": "TM_Session_1",
                "Description": "TM_Session_1_Description",
                "Status": "Active",
                "BusinessStatus": "FinancialLocked",
                "LockReason": "financial",
                "VirtualNetworkId": 2,
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key":"k1",
                        "Value":"v1"
                    }
                 ]           
            }
         ]
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
400	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	查询数量不合法。
400	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	查询 NextToken 不合法。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	InvalidTrafficMirrorSession.Malformed	The specified traffic mirror session is malformed. Ensure that IDs and names cannot be specified at the same time.	指定的流量镜像会话不合法。请确保不能同时指定ID和名称。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。
400	LimitExceeded.TrafficMirrorSessionIds	You've reached the limit on the number of traffic mirror session IDs that you can describe.	已达到可查询的镜像流量会话ID数量上限。
400	LimitExceeded.TrafficMirrorSessionNames	You've reached the limit on the number of traffic mirror session names that you can describe.	已达到可查询的镜像流量会话名数量上限。