创建流量镜像会话
功能介绍
创建流量镜像会话。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。
URI
POST /v3/{project_id}/vpc/traffic-mirror-sessions
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 获取方式请参见获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
traffic_mirror_session |
是 |
流量镜像会话对象 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
否 |
String |
功能说明:指定VNI,用于区分不同会话的镜像流量 取值范围:0~16777215 默认值:1 |
packet_length |
否 |
String |
功能说明:最大传输单元MTU 取值范围:1~1460 默认值:96 |
priority |
是 |
Integer |
功能说明:会话优先级 取值范围:1~32766 |
enabled |
否 |
String |
功能说明:是否开启会话 取值范围:true、false 默认值:false |
type |
否 |
String |
功能说明:支持的镜像源类型 取值范围: eni,弹性网卡 eip,弹性公网IP |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
traffic_mirror_session |
TrafficMirrorSession object |
流量镜像会话对象 |
request_id |
String |
请求ID |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
功能说明:更新时间戳 |
请求示例
创建流量镜像会话,命名为test-session
POST http://{endpoint}/v3/{project_id}/vpc/traffic-mirror-sessions { "traffic_mirror_session" : { "name" : "test-session", "traffic_mirror_filter_id" : "b765ba87-c0b4-4f1a-9ec3-d5b1d1ddb137", "traffic_mirror_sources" : [ "6134900d-31a6-4b71-8453-dbca7f26982a" ], "traffic_mirror_target_id" : "c9f8acef-d550-4fbe-be7c-e8bfd3501dc1", "traffic_mirror_target_type" : "eni", "priority" : 11 } }
响应示例
状态码: 201
Created
{ "traffic_mirror_session" : { "name" : "test-session", "created_at" : "2023-03-23T10:53:12.000+00:00", "updated_at" : "2023-03-23T10:53:12.000+00:00", "id" : "16538eda-7e94-4b90-b5f3-a653f62dc817", "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" : "c9f8acef-d550-4fbe-be7c-e8bfd3501dc1", "traffic_mirror_target_type" : "eni", "virtual_network_id" : 1, "packet_length" : 96, "priority" : 11, "enabled" : true, "type" : "eni" }, "request_id" : "9a880225-1d2f-461e-8d8e-1866bfda77db" }
状态码
状态码 |
描述 |
---|---|
201 |
Created |
错误码
请参见错误码。