调用ListTrafficMirrorSessions接口查询镜像会话的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTrafficMirrorSessions

系统规定参数。取值:ListTrafficMirrorSessions

TrafficMirrorSessionName String abc

镜像会话的名称。

名称长度为1~128个字符,不能以http://https://开头。

MaxResults Integer 10

本次查询的最大记录条数。取值范围:1~100。默认值:10

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
TrafficMirrorSourceId String eni-j6c8znm5l1yt4sox*****

镜像源的实例ID,目前支持弹性网卡作为镜像源。

TrafficMirrorTargetId String eni-j6c2fp57q8rr47rp****

镜像目的的实例ID,目前支持弹性网卡和私网负载均衡实例作为镜像目的。

TrafficMirrorFilterId String tmf-j6cmls82xnc86vtpe****

流量镜像筛选条件的实例ID。

VirtualNetworkId Integer 10

指定VNI,用来区分不同的镜像流量,取值范围为0~16777215。您可以通过VNI在镜像目的区分不同会话的镜像流量。您可以自定义VNI的值,也可以由系统随机分配该值。如果由系统随机分配该值,请不传该参数。

Priority Integer 1

镜像会话的优先级,取值范围为1~32766

数字越小,优先级越高。同一账号在同一个地域创建的镜像会话优先级不能重复。

Enabled Boolean false

是否开启流量会话,取值:

  • false(默认值):不开启流量会话。
  • true:开启流量会话。
TrafficMirrorSessionIds.N String tms-j6cla50buc44ap8tu****

镜像会话的实例ID。其中N最大取值为100,即支持查询最多100个镜像会话。

RegionId String cn-hongkong

镜像会话的所属地域ID。您可以通过调用DescribeRegions接口获取地域ID。关于流量镜像支持的地域,请参见流量镜像概述

ResourceGroupId String rg-bp67acfmxazb4ph****

需要查询的流量镜像所属的资源组ID。

Tags.N.Key String FinanceDept

资源的标签键。最多支持输入20个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持128个字符,不能以aliyunacs:开头,不能包含http://或者https://

Tags.N.Value String FinanceJoshua

资源的标签值。最多支持输入20个标签值。如需传入该值,可以输入空字符串。

最多支持128个字符,不能以aliyunacs:开头,不能包含http://或者https://

返回数据

名称 类型 示例值 描述
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String 739CA01C-92EB-4C69-BCC0-280149C6F41E

请求ID。

TotalCount String 1

返回结果总数。

TrafficMirrorSessions Array of TrafficMirrorSession

镜像会话的详情列表。

TrafficMirrorTargetId String eni-j6c2fp57q8rr47rp****

镜像目的的实例ID。

TrafficMirrorSessionId String tms-j6cla50buc44ap8tu****

镜像会话的实例ID。

Priority Integer 1

镜像会话的优先级。

数字越小,优先级越高。

TrafficMirrorTargetType String NetworkInterface

镜像目的类型,取值:

  • NetworkInterface:弹性网卡。
  • SLB:私网负载均衡实例。
PacketLength Integer 1500

最大传输单元MTU(Maximum Transmission Unit)。

TrafficMirrorSessionDescription String This is a session.

镜像会话的描述信息。

TrafficMirrorSessionStatus String Created

镜像会话的状态,取值:

  • Creating:创建中。
  • Created:已创建。
  • Modifying:修改中。
  • Deleting:删除中。
Enabled Boolean false

是否已开启流量会话,取值:

  • false(默认值):不开启流量会话。
  • true:开启流量会话。
TrafficMirrorSessionBusinessStatus String Normal

镜像会话的业务状态,取值:

  • Normal:正常。
  • FinancialLocked:欠费锁定。
VirtualNetworkId Integer 10

指定VNI,用来区分不同的镜像流量。

TrafficMirrorFilterId String tmf-j6cmls82xnc86vtpe****

流量镜像筛选条件的实例ID。

TrafficMirrorSessionName String abc

镜像会话的名称。

TrafficMirrorSourceIds Array of String eni-j6c8znm5l1yt4sox****

镜像源的实例ID。

ResourceGroupId String rg-bp67acfmxazb4ph****

流量镜像所属的资源组ID。

Tags Array of Tag

标签列表。

Key String FinanceDept

标签键。

Value String FinanceJoshua

标签值。

示例

请求示例

http(s)://[Endpoint]/?Action=ListTrafficMirrorSessions
&TrafficMirrorSessionName=abc
&MaxResults=10
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&TrafficMirrorSourceId=eni-j6c8znm5l1yt4sox*****
&TrafficMirrorTargetId=eni-j6c2fp57q8rr47rp****
&TrafficMirrorFilterId=tmf-j6cmls82xnc86vtpe****
&VirtualNetworkId=10
&Priority=1
&Enabled=false
&TrafficMirrorSessionIds=["tms-j6cla50buc44ap8tu****"]
&RegionId=cn-hongkong
&ResourceGroupId=rg-bp67acfmxazb4ph****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTrafficMirrorSessionsResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>739CA01C-92EB-4C69-BCC0-280149C6F41E</RequestId>
    <TotalCount>1</TotalCount>
    <TrafficMirrorSessions>
        <TrafficMirrorTargetId>eni-j6c2fp57q8rr47rp****</TrafficMirrorTargetId>
        <TrafficMirrorSessionId>tms-j6cla50buc44ap8tu****</TrafficMirrorSessionId>
        <Priority>1</Priority>
        <TrafficMirrorTargetType>NetworkInterface</TrafficMirrorTargetType>
        <PacketLength>1500</PacketLength>
        <TrafficMirrorSessionDescription>This is a session.</TrafficMirrorSessionDescription>
        <TrafficMirrorSessionStatus>Created</TrafficMirrorSessionStatus>
        <Enabled>false</Enabled>
        <TrafficMirrorSessionBusinessStatus>Normal</TrafficMirrorSessionBusinessStatus>
        <VirtualNetworkId>10</VirtualNetworkId>
        <TrafficMirrorFilterId>tmf-j6cmls82xnc86vtpe****</TrafficMirrorFilterId>
        <TrafficMirrorSessionName>abc</TrafficMirrorSessionName>
        <TrafficMirrorSourceIds>eni-j6c8znm5l1yt4sox****</TrafficMirrorSourceIds>
        <ResourceGroupId>rg-bp67acfmxazb4ph****</ResourceGroupId>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceJoshua</Value>
        </Tags>
    </TrafficMirrorSessions>
</ListTrafficMirrorSessionsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "739CA01C-92EB-4C69-BCC0-280149C6F41E",
  "TotalCount" : "1",
  "TrafficMirrorSessions" : [ {
    "TrafficMirrorTargetId" : "eni-j6c2fp57q8rr47rp****",
    "TrafficMirrorSessionId" : "tms-j6cla50buc44ap8tu****",
    "Priority" : 1,
    "TrafficMirrorTargetType" : "NetworkInterface",
    "PacketLength" : 1500,
    "TrafficMirrorSessionDescription" : "This is a session.",
    "TrafficMirrorSessionStatus" : "Created",
    "Enabled" : false,
    "TrafficMirrorSessionBusinessStatus" : "Normal",
    "VirtualNetworkId" : 10,
    "TrafficMirrorFilterId" : "tmf-j6cmls82xnc86vtpe****",
    "TrafficMirrorSessionName" : "abc",
    "TrafficMirrorSourceIds" : [ "eni-j6c8znm5l1yt4sox****" ],
    "ResourceGroupId" : "rg-bp67acfmxazb4ph****",
    "Tags" : [ {
      "Key" : "FinanceDept",
      "Value" : "FinanceJoshua"
    } ]
  } ]
}

错误码

访问错误中心查看更多错误码。