接口功能介绍
查看镜像会话列表
接口约束
无
URI
GET /v4/flowsession/list
请求参数
Query 参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
regionID | String | 是 | 区域ID | 81f7728662dd11ec810800155d307d5b |
mirrorFilterID | String | 否 | 镜像会话 id | mrfilter-2ck692kf8o |
queryContent | String | 否 | 按名字进行模糊过滤 | test |
pageNumber | Integer | 否 | 列表的页码,默认值为 1。 | 1 |
pageSize | Integer | 否 | 分页查询时每页的行数,最大值为 50,默认值为 10。 | 10 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 |
message | String | statusCode为900时的错误信息,英文 | success |
descritption | String | statusCode为800时的错误信息,中文 | 成功 |
errorCode | String | 错误明细 | SUCCESS |
returnObj | Object | 接口业务数据 | 见下表 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
flowSessions | Array of Objects | 流量镜像过滤规则列表 | 见下表 |
totalCount | Integer | 列表条目数 | 1 |
currentCount | Integer | 分页查询时每页的行数。 | 1 |
totalPage | Integer | 总页数 | 1 |
表 flowSessions
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
mirrorFilterID | String | 过滤规则 ID | mrfilter-2ck692kf8o |
srcPort | String | 源弹性网卡 ID | port-xxxxx |
dstPort | String | 源弹性网卡 ID | port-yyyyy |
createdTime | String | 创建时间 | 2023-04-04T07:11:15Z |
flowSessionID | String | 会话 ID | mrflow-31tovfsae3 |
name | String | 会话名称 | test |
description | String | 会话描述 | test |
vni | Integer | VXLAN 网络标识符 | 1 |
dstPortType | String | 目标网卡类型: VM | VM |
status | String | 会话状态:on / off | on |
请求示例
GET /v4/flowsession/list?regionID=81f7728662dd11ec810800155d307d5b
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"flowSessions": [
{
"mirrorFilterID": "mrfilter-2ck692kf8o",
"srcPort": "port-xxxxx",
"dstPort": "port-yyyyy",
"createdTime": "2023-04-04T07:11:15Z",
"name": "test",
"description": "test",
"vni": 1,
"dstPortType": "VM",
"status": "on",
"flowSessionID": "mrflow-31tovfsae3"
}
],
"totalCount": 1,
"currentCount": 1,
"totalPage": 1
}
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。