更新时间:2026-01-09 GMT+08:00

查询流量镜像会话列表

功能介绍

当您的流量镜像会话创建成功后,您可以通过该接口查询所有流量镜像会话信息,包括流量镜像会话的名称、类型等。

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/vpc/traffic-mirror-sessions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

流量镜像会话所属的项目ID。

取值范围:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

id

否

Array of strings

参数解释:

流量镜像会话的资源ID,可以通过此字段精确过滤流量镜像会话,支持传入多个ID过滤。

取值范围:

不涉及。

name

否

Array of strings

参数解释:

流量镜像会话的名称,可以通过此字段过滤流量镜像会话,支持传入多个名称过滤。

取值范围:

不涉及。

description

否

Array of strings

参数解释:

流量镜像会话的描述信息,可以通过此字段过滤流量镜像会话,支持传入多个描述信息进行过滤。

取值范围:

不涉及。

enabled

否

Boolean

参数解释:

是否开启流量镜像会话,可以通过此字段过滤流量镜像会话,不支持传入多个值过滤。

取值范围:

  • true:过滤出开启状态的流量镜像会话。

  • false:过滤出关闭状态的流量镜像会话。

packet_length

否

Array of integers

参数解释:

流量镜像会话的镜像报文长度,可以通过此字段过滤流量镜像会话,支持传入多个镜像报文长度过滤。

取值范围:

1~1460

priority

否

Array of integers

参数解释:

流量镜像会话的优先级,可以通过此字段过滤流量镜像会话,支持传入多个优先级过滤。

取值范围:

1~32766

traffic_mirror_filter_id

否

Array of strings

参数解释:

流量镜像会话关联的筛选条件的ID,可以通过此字段过滤流量镜像会话,支持传入多个ID过滤。

取值范围:

不涉及。

traffic_mirror_target_type

否

Array of strings

参数解释:

流量镜像会话的镜像目的类型,可以通过此字段过滤流量镜像会话,支持传入多个类型过滤。

取值范围:

  • eni:镜像目的类型是弹性网卡。

  • elb:镜像目的类型是私网弹性负载均衡。

traffic_mirror_target_id

否

Array of strings

参数解释:

流量镜像会话的镜像目的ID,可以通过此字段过滤流量镜像会话,支持传入多个ID过滤。

取值范围:

不涉及。

type

否

Array of strings

参数解释:

流量镜像会话的镜像源类型,可以通过此字段过滤流量镜像会话,支持传入多个类型过滤。

取值范围:

  • eni:弹性网卡

  • eip:弹性公网IP

virtual_network_id

否

Array of integers

参数解释:

流量镜像会话的VXLAN网络标识(VNI),可以通过此字段过滤流量镜像会话,支持传入多个VNI过滤。

取值范围:

0~16777215

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

traffic_mirror_sessions

Array of TrafficMirrorSession objects

参数解释:

查询流量镜像会话列表的响应体。

取值范围:

不涉及。

page_info

PageInfo object

参数解释:

分页信息

取值范围:

不涉及。

request_id

String

参数解释:

请求ID。

取值范围:

不涉及。

表4 TrafficMirrorSession

参数

参数类型

描述

id

String

参数解释:

流量镜像会话的资源ID。流量镜像会话创建成功后,会生成一个流量镜像会话 ID,是流量镜像会话对应的唯一标识。

取值范围:

不涉及。

project_id

String

参数解释:

流量镜像会话所属的项目ID。

取值范围:

不涉及。

name

String

参数解释:

流量镜像会话的名称。

取值范围:

1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。

description

String

参数解释:

流量镜像会话的描述信息。

取值范围:

0-255个字符,不能包含“<”和“>”。

traffic_mirror_filter_id

String

参数解释:

流量镜像会话关联的筛选条件的ID。

取值范围:

不涉及。

traffic_mirror_sources

Array of strings

参数解释:

流量镜像会话关联的镜像源的ID列表,支持弹性网卡作为镜像源。

取值范围:

一个流量镜像会话默认最大支持10个镜像源。

traffic_mirror_target_id

String

参数解释:

流量镜像会话关联的镜像目的ID。

取值范围:

不涉及。

traffic_mirror_target_type

String

参数解释:

流量镜像会话关联的镜像目的的类型。

取值范围:

  • eni:镜像目的类型是弹性网卡。

  • elb:镜像目的类型是私网弹性负载均衡。

virtual_network_id

Integer

参数解释:

流量镜像会话的VXLAN网络标识(VNI),用于区分不同会话的镜像流量。

取值范围:

0~16777215,默认值是1。

packet_length

Integer

参数解释:

流量镜像会话的镜像报文长度。

取值范围:

1~1460,默认值是96。

priority

Integer

参数解释:

流量镜像会话的优先级。

取值范围:

1~32766。

enabled

Boolean

参数解释:

是否开启流量镜像会话。

取值范围:

  • true:开启流量镜像会话。

  • false:默认值,关闭流量镜像会话。

type

String

参数解释:

流量镜像会话的镜像源的类型。

取值范围:

  • eni:弹性网卡

  • eip:弹性公网IP

created_at

String

参数解释:

流量镜像会话的创建时间。

取值范围:

UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。

updated_at

String

参数解释:

流量镜像会话的更新时间。

取值范围:

UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。

表5 PageInfo

参数

参数类型

描述

previous_marker

String

参数解释:

当前页的第一条记录。

取值范围:

不涉及。

current_count

Integer

参数解释:

当前页的资源总数。

取值范围:

不涉及。

next_marker

String

参数解释:

当前页的最后一条记录,最后一页时无next_marker字段。

取值范围:

不涉及。

请求示例

查询流量镜像会话列表

GET http://{endpoint}/v3/{project_id}/vpc/traffic-mirror-sessions

响应示例

状态码:200

OK

{
  "request_id" : "f87354b7-eecd-4b64-87f6-bfd6430e33bd",
  "traffic_mirror_sessions" : [ {
    "name" : "test-session",
    "created_at" : "2023-03-14T08:44:12.000+00:00",
    "updated_at" : "2023-03-14T08:44:12.000+00:00",
    "id" : "6cc12480-5a92-4aed-99fb-07c52cc98961",
    "project_id" : "7365fcd452924e398ec4cc1fe39c0d12",
    "description" : "",
    "traffic_mirror_filter_id" : "b765ba87-c0b4-4f1a-9ec3-d5b1d1ddb137",
    "traffic_mirror_sources" : [ "6134900d-31a6-4b71-8453-dbca7f26982a" ],
    "traffic_mirror_target_id" : "029ab12b-dc38-4228-b146-44975bf55250",
    "traffic_mirror_target_type" : "eni",
    "virtual_network_id" : 1,
    "packet_length" : 96,
    "priority" : 9,
    "enabled" : true,
    "type" : "eni"
  } ],
  "page_info" : {
    "previous_marker" : "6cc12480-5a92-4aed-99fb-07c52cc98961",
    "current_count" : 1
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。