调用ListTrafficMirrorSessions接口查询镜像会话的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListTrafficMirrorSessions |
要执行的操作。取值:ListTrafficMirrorSessions。 |
RegionId | String | 是 | cn-hongkong |
镜像会话的所属地域ID。您可以通过调用DescribeRegions接口获取地域ID。关于流量镜像支持的地域,请参见流量镜像概述。 |
TrafficMirrorSessionName | String | 否 | abc |
镜像会话的名称。 |
MaxResults | Integer | 否 | 10 |
本次查询的最大记录条数。取值范围:1~100。默认值:10。 |
NextToken | String | 否 | caeba0bbb2be03f84eb48b699f0a4883 |
查询凭证(Token),取值为上一次API调用返回的NextToken参数值。如果没有下一个查询,请不传。 |
TrafficMirrorSessionIds.N | RepeatList | 否 | tms-j6cla50buc44ap8tu**** |
镜像会话的实例ID。其中N最大取值为100,即支持查询最多100个镜像会话。 |
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 |
是否开启流量会话,取值:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
NextToken | String | caeba0bbb2be03f84eb48b699f0a4883 |
下一个查询开始Token,NextToken为空说明没有下一个。 |
RequestId | String | 739CA01C-92EB-4C69-BCC0-280149C6F41E |
请求ID。 |
TotalCount | String | 1 |
返回结果总数。 |
TrafficMirrorSessions | Array of TrafficMirrorSession |
镜像会话的详情列表。 |
|
Enabled | Boolean | false |
是否已开启流量会话,取值:
|
PacketLength | Integer | 1500 |
最大传输单元MTU(Maximum Transmission Unit)。 |
Priority | Integer | 1 |
镜像会话的优先级。 数字越小,优先级越高。 |
TrafficMirrorFilterId | String | tmf-j6cmls82xnc86vtpe**** |
流量镜像筛选条件的实例ID。 |
TrafficMirrorSessionBusinessStatus | String | Normal |
镜像会话的业务状态,取值:
|
TrafficMirrorSessionDescription | String | This is a session. |
镜像会话的描述信息。 |
TrafficMirrorSessionId | String | tms-j6cla50buc44ap8tu**** |
镜像会话的实例ID。 |
TrafficMirrorSessionName | String | test |
镜像会话的名称。 |
TrafficMirrorSessionStatus | String | Created |
镜像会话的状态,取值:
|
TrafficMirrorSourceIds | List | eni-j6c8znm5l1yt4sox**** |
镜像源的实例ID。 |
TrafficMirrorTargetId | String | eni-j6c2fp57q8rr47rp**** |
镜像目的的实例ID。 |
TrafficMirrorTargetType | String | NetworkInterface |
镜像目的类型,取值:
|
VirtualNetworkId | Integer | 10 |
指定VNI,用来区分不同的镜像流量。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListTrafficMirrorSessions
&RegionId=cn-hongkong
&<公共请求参数>
正常返回示例
XML
格式
<ListTrafficMirrorFiltersResponse>
<TotalCount>1</TotalCount>
<NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
<RequestId>739CA01C-92EB-4C69-BCC0-280149C6F41E</RequestId>
<TrafficMirrorSessions>
<TrafficMirrorTargetId>eni-j6c2fp57q8rr47rp****</TrafficMirrorTargetId>
<TrafficMirrorSessionStatus>Created</TrafficMirrorSessionStatus>
<VirtualNetworkId>10</VirtualNetworkId>
<TrafficMirrorSessionBusinessStatus>Normal</TrafficMirrorSessionBusinessStatus>
<Priority>1</Priority>
<PacketLength>1500</PacketLength>
<Enabled>false</Enabled>
<TrafficMirrorSessionDescription>This is a session.</TrafficMirrorSessionDescription>
<TrafficMirrorSessionId>tms-j6cla50buc44ap8tu****</TrafficMirrorSessionId>
<TrafficMirrorSessionName>test</TrafficMirrorSessionName>
<TrafficMirrorFilterId>tmf-j6cmls82xnc86vtpe****</TrafficMirrorFilterId>
<TrafficMirrorTargetType>NetworkInterface</TrafficMirrorTargetType>
<TrafficMirrorSourceIds>eni-j6c8znm5l1yt4sox****</TrafficMirrorSourceIds>
</TrafficMirrorSessions>
</ListTrafficMirrorFiltersResponse>
JSON
格式
{
"TotalCount": 1,
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "739CA01C-92EB-4C69-BCC0-280149C6F41E",
"TrafficMirrorSessions": {
"TrafficMirrorTargetId": "eni-j6c2fp57q8rr47rp****",
"TrafficMirrorSessionStatus": "Created",
"VirtualNetworkId": 10,
"TrafficMirrorSessionBusinessStatus": "Normal",
"Priority": 1,
"PacketLength": 1500,
"Enabled": false,
"TrafficMirrorSessionDescription": "This is a session.",
"TrafficMirrorSessionId": "tms-j6cla50buc44ap8tu****",
"TrafficMirrorSessionName": "test",
"TrafficMirrorFilterId": "tmf-j6cmls82xnc86vtpe****",
"TrafficMirrorTargetType": "NetworkInterface",
"TrafficMirrorSourceIds": "eni-j6c8znm5l1yt4sox****"
}
}
错误码
访问错误中心查看更多错误码。