文档首页/ 虚拟私有云 VPC/ API参考/ API V3/ 流量镜像会话/ 查询流量镜像会话列表
更新时间：2024-10-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询流量镜像会话列表

功能介绍

查询流量镜像会话列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方式请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

id

否

String

使用镜像会话ID过滤或排序

name

否

String

使用镜像会话名称过滤或排序

description

否

String

使用镜像会话描述过滤

enabled

否

String

使用enabled过滤

packet_length

否

String

使用最大传输单元MTU过滤

priority

否

String

使用镜像会话优先级过滤

traffic_mirror_filter_id

否

String

使用筛选条件ID过滤

traffic_mirror_target_type

否

String

使用镜像目的类型过滤

traffic_mirror_target_id

否

String

使用镜像目的ID过滤

type

否

String

使用镜像源类型过滤

virtual_network_id

否

String

使用VNI过滤

created_at

否

String

使用创建时间戳排序

updated_at

否

String

使用更新时间戳排序

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

traffic_mirror_sessions

Array of TrafficMirrorSession objects

流量镜像会话

page_info

PageInfo object

分页信息

request_id

String

请求ID
表4 TrafficMirrorSession

参数

参数类型

描述

id

String

功能说明：流量镜像会话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

功能说明：指定VNI，用于区分不同会话的镜像流量

取值范围：0~16777215

默认值：1

packet_length

Integer

功能说明：最大传输单元MTU

取值范围：1~1460

默认值：96

priority

Integer

功能说明：会话优先级

取值范围：1~32766

enabled

Boolean

功能说明：是否开启会话

取值范围：true、false

默认值：false

type

String

功能说明：支持的镜像源类型

取值范围：eni，弹性网卡

created_at

String

功能说明：创建时间戳

updated_at

String

功能说明：更新时间戳
表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

错误码

请参见错误码。

父主题： 流量镜像会话