华为乾坤-配置NetStream全局配置:响应参数

时间:2025-02-17 11:37:29

响应参数

返回状态码为200:配置成功,响应体参考NetstreamResponse。

表9 NetstreamResponse对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

errCode

string

0~10个字符。

-

错误码。

"0"

errMsg

string

0~255个字符。

-

错误描述。

""

data

REFERENCE

详细请参见表10

NetStream info。

-

表10 netstreamInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

config-status

string

  • reserved

  • initial

  • configuring-database

  • configured-database-success

  • configured-database-failed

  • configuring-device

  • configured-device-success

  • configured-device-failed

reserved

1:配置状态;

2:查询接口返回业务数据配置状态结果;

3:创建、修改、删除不返回状态;

4:入参设置此字段无效;

5:取值范围:

reserved:保留未用,

initial:初始状态,

configuring-database:数据库存储中,

configured-database-success:预配置,

configured-database-failed:数据库存储失败,

configuring-device:部署中,

configured-device-success:成功,

configured-device-failed:失败。

-

errorInfo

string

0~1000个字符。

-

配置下发结果错误描述。

""

flowInsts

REFERENCE

详细请参见表11

全局参数流实例列表。

-

flexFlowRecords

REFERENCE

详细请参见表14

灵活流模板列表,仅V600系列设备支持。

-

tmAfterEnable

boolean

  • true

  • false

false

配置设备在队列调度后进行采样。

false

sourceIdExtendEnable

boolean

  • true

  • false

false

启用源id扩展模式,仅V600系列设备支持。

false

表11 flowInsts对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

flowInst

ARRAY_REFERENCE

1个列表项,详细请参见表12

配置全局流实例。当前只支持配置一个流实例,即IPV4类型的流实例。

-

表12 flowInst对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

flowType

string

  • IPv4

-

流类型,取值范围:当前仅支持IPv4,主键字段。

"IPv4"

sourceIpv4Address

string

0~15个字符。

-

源IP地址,当前仅支持IPv4地址,修改场景支持填null,表示不修改,维持原有值。

"192.168.1.1"

sourceIpv4Port

int32

[1-65535]

-

源端口。仅V300系列设备支持该参数。

2000

exportVersion

int32

  • 5

  • 9

  • 10

-

V300系列设备支持版本号:5, 9, 10。V600系列设备支持5, 9。

5

indexSwitch

int32

  • 16

  • 32

32

接口索引。

32

tcpSessionTimeout

boolean

  • true

  • false

false

当tcp会话结束时,老化流。

false

preClassify

boolean

  • true

  • false

false

使能预提取功能。仅V300系列设备支持该参数。

false

sysMacEnable

boolean

  • true

  • false

false

使能sysmac采样。只有V300系列设备支持该参数。

false

originActiveAgeSeconds

int32

[60-3600]

1800

活跃流老化时间,单位秒。默认值1800秒。

1800

originInactiveSeconds

int32

[5-600]

-

非活跃流老化时间,单位秒。 V300系列设备范围10到600, 默认值为30。 V600系列设备范围5到600, 默认值15。

15

templateTimeoutRate

int32

[1-3600]

1

模板刷新率。V600系列设备默认值为1。V300系列设备默认值为30。单位为分钟。

1

exportIpV4Hosts

ARRAY_REFERENCE

0-2个列表项,详细请参见表13

目的主机列表。

-

表13 exportIpV4Host对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

address

string

满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。

-

目的地址,目标主机的IP地址不能相同。

"192.168.2.1"

port

int32

[1-65535]

-

目的端口号。

2000

vpnName

string

0~31个字符。

-

Vpn实例名。

"underlay_1"

dscpValue

int32

[0-63]

-

DSCP值。只有V600系列设备支持该参数,默认值为0。

15

表14 flexFlowRecords对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

flexFlowRecord

ARRAY_REFERENCE

1-16个列表项,详细请参见表15

灵活流模板,仅V600系列设备支持,支持增量修改。

-

表15 flexFlowRecord对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

flowType

string

  • IPv4

-

流类型,取值范围:当前仅支持IPv4,联合主键字段。

"IPv4"

recordName

string

1~32个字符。满足正则表达([^?"']{1,32})|("[^?"']{1,30}")|('[^?"']{1,30}')。

-

灵活流模板名,联合主键字段。

"record1"

protocol

boolean

  • true

  • false

false

采集协议。

true

tos

boolean

  • true

  • false

false

采集服务类型。

true

sourceAddress

boolean

  • true

  • false

false

采集源地址。

true

destinationAddress

boolean

  • true

  • false

false

采集目的地址。

true

sourcePort

boolean

  • true

  • false

false

采集源端口。

true

destinationPort

boolean

  • true

  • false

false

采集目的端口。

true

bytesValue

boolean

  • true

  • false

false

采集字节数。

true

packetsValue

boolean

  • true

  • false

false

采集报文个数。

false

inputInterface

boolean

  • true

  • false

false

采集入接口索引。

false

outputInterface

boolean

  • true

  • false

false

采集出接口索引。

false

sdWanConnection

boolean

  • true

  • false

false

采集隧道信息。

false

applicationName

boolean

  • true

  • false

false

采集应用信息。

false

sysMacEnable

boolean

  • true

  • false

false

sysmac使能。

false

返回状态码为400:请求参数错误。

详细信息请参见实际响应消息体。

返回状态码为500:内部异常。

详细信息请参见实际响应消息体。

support.huaweicloud.com/qiankuncmn-qiankuncs/toctopics/zh-cn_topic_0000002128678902.html