批量创建策略行为模板_华为乾坤

典型场景

用于批量创建策略行为模板。

接口功能

批量创建策略行为模板。

接口约束

该接口仅支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用。

调用方法

POST

URI

/controller/campus/v1/sdwan/policy/traffic/behavior-profile

请求参数

表1 body参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
trafficBehaviorInfos	是	REFERENCE	详细请参见表2。		创建策略行为模板请求数据，type为必填字段，id为后端随机生成的uuid。	-

表2 TrafficBehaviorInfos对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
trafficBehaviors	否	ARRAY_REFERENCE	1-1000个列表项，详细请参见表3。		策略行为模板列表。	-

表3 TrafficBehaviorInfo对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
id	否	uuid	-	-	策略行为模板ID，修改或删除的时候必填。主键字段。	"00000000-0000-0000-0000-000000000000"
name	否	string	1~64个字符。	-	模板名称，创建的时候必填。该参数唯一。不支持特殊字符。模板名称由汉字、小写字母、大写字母、数字、下划线或短横线组成的字符串。	"templateName"
type	是	string	1~64个字符。	-	模板类型，必填参数。取值范围：redirect、qos（不区分大小写），redirect表示重定向行为模板，qos表示qos行为模板。	"qos"
redirectInfo	否	REFERENCE	详细请参见表4。		redirect的行为模板结构体。type类型为redirect时，redirectInfo生效。	-
qosInfo	否	REFERENCE	详细请参见表5。		Qos的行为模板结构体，id和name使用外层结构体的，qosInfo中无需填写。type类型为qos时，qosInfo生效。	-

表4 RedirectInfo对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
nextHopType	否	string	0~10个字符。满足正则表达^(ip\|tenantSite\|mspSite)$。	ip	重定向下一跳支持的类型，ip：IP地址类型，tenantSite：租户站点类型，mspSite：MSP站点类型，默认为ip。仅V600R024C00及之后版本的AR设备(不包括AR6700V-L)支持配置tenantSite、mspSite类型。	"ip"
nextHop	否	string	0~64个字符。	-	主重定向下一跳IP地址，支持IPv4、IPv6，与backupNextHop的IP地址不能相同。 nextHopType为ip时有效，且nextHopType为ip时创建必填。 V300系列设备仅V300R022C10及以上版本支持配置IPv6类型地址，V600系列设备仅V600R022C10及以上版本支持配置IPv6类型地址。	"192.168.2.254"
nextHopSiteId	否	string	0~36个字符。	-	主重定向下一跳站点ID，与backupNextHopSiteId不能相同。 nextHopType为tenantSite、mspSite时有效，且nextHopType为tenantSite、mspSite时创建必填。	"000000-0000-0000-0000-000000000000"
nextHopSiteName	否	string	0~64个字符。	-	主重定向下一跳站点名称。仅查询接口使用。	"site"
trackIp	否	string	0~64个字符。	-	主重定向探测IP地址，支持IPv4，与backupTrackIp的IP地址不能相同。 nextHopType为ip时有效。	"192.168.2.2"
backupNextHop	否	string	0~64个字符。	-	备重定向下一跳IP地址，支持IPv4，与nextHop的IP地址不能相同。 nextHopType为ip时有效。	"192.168.2.224"
backupNextHopSiteId	否	string	0~36个字符。	-	备重定向下一跳站点ID，与nextHopSiteId不能相同。 nextHopType为tenantSite、mspSite时有效。	"000000-0000-0000-0000-000000000000"
backupNextHopSiteName	否	string	0~64个字符。	-	备重定向下一跳站点名称。仅查询接口使用。	"site"
backupTrackIp	否	string	0~64个字符。	-	备重定向探测IP地址，支持IPv4，与trackIp地址不能相同。 nextHopType为ip时有效。	"192.168.2.222"

表5 QosProfileInfo对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
id	否	uuid	-	-	模板ID，主键字段。修改或删除的时候必填。	"00000000-0000-0000-0000-000000000000"
name	否	string	1~64个字符。满足正则表达^[\u4e00-\u9fa5a-zA-Z0-9_-]+$。	-	模板名称，只能包含汉字、字母、数字、下划线和横线。调用批量创建QoS模板接口时必填，该参数唯一。调用策略行为模板接口时，仅做返回值使用。	"templateName"
inboundCar	否	REFERENCE	详细请参见表6。		入方向QoS的Car结构体。	-
enableQueuePriority	否	boolean	true false	false	是否开启队列优先级。 enableQueuePriority和enableBandwidthLimit至少有一个为true。如果入方向QoS使能，则只能为false。如果配置为true，priorityLevel必填，guaranteedBandwidthValue和guaranteedBandwidthPercentage至少配置一个。 V600系列设备必须开启队列优先级。	false
priorityLevel	否	string	4~7个字符。	-	队列优先级，取值范围：highest、high、medium（不区分大小写），highest表示最高，high表示高，medium表示中等。 V300系列设备支持highest、high、medium,V600系列设备只支持highest、medium。当priorityLevel为medium时，V600系列设备必须配置guaranteedBandwidthPercentage。当priorityLevel为highest时，V600系列设备配置guaranteedBandwidthValue或guaranteedBandwidthPercentage不生效。	"highest"
guaranteedBandwidthValue	否	double	[0.01-10000]	-	保证带宽（Mbps），不能和guaranteedBandwidthPercentage同时存在。	1
guaranteedBandwidthPercentage	否	int32	-	-	保证带宽，百分比形式，范围1-99，不能和guaranteedBandwidthValue同时存在。同一个VPN同一个站点下guaranteedBandwidthPercentage之和建议小于100。只有在队列优先级使能的情况下，才能配置队列的长度（字节或包）。	10
enableBandwidthLimit	否	boolean	true false	false	是否开启带宽限制。 enableQueuePriority和enableBandwidthLimit至少有一个为true。如果配置为true，limitType必填，limitBandwidthValue和limitBandwidthPercentage至少配一个。如果入方向QoS使能，则只能为false。	false
limitType	否	string	3~7个字符。	-	带宽限制类型，该字段可以设置为以下几种： a) CAR：流量监管 b) Shaping：流量整形 V600系列设备仅V600R022C00及以上的版本支持流量监管。	"CAR"
limitBandwidthValue	否	double	[0.01-100000]	-	限制带宽（Mbps），不能和limitBandwidthPercentage同时存在。 V300系列设备支持最大值为10000，最小值为0.01。V600系列设备支持最大值为100000，最小值为0.024。	1
limitBandwidthPeakValue	否	double	[0.01-10000]	-	该字段已废弃。限制带宽（Mbps）峰值流量速率，只对入方向QOS有效。取值必须大于等于limitBandwidthValue，缺省等于limitBandwidthValue。	1
limitBandwidthPercentage	否	int32	-	-	限制带宽，百分比形式，范围1-99，不能和limitBandwidthValue同时存在。	10
enableRemarkDscp	否	boolean	true false	-	是否重新标记DSCP值,默认值为false。如果入方向QoS使能，V600版本的设备不支持DSCP标记，如果配置为true，remarkDscpValue必填。	false
remarkDscpValue	否	int32	[0-63]	-	重新标记的DSCP值，范围0-63，当enableRemarkDscp为true时生效。	10
enableRemark8021p	否	boolean	true false	-	是否重新标记8021P值，默认值为false。如果入方向QoS使能，则只能为false。如果配置为true，remark8021pValue必填。	false
remark8021pValue	否	int32	[0-7]	-	重新标记的8021P值，范围0-7，当enableRemark8021p为true时生效。	1
enableRemarkMplsExp	否	boolean	true false	-	是否重新标记mpls-exp值，默认值为false。如果入方向QoS使能，则只能为false。 V600系列设备只能为false。如果配置为true，remarkMplsExpValue必填。	false
remarkMplsExpValue	否	int32	[0-7]	-	重新标记的mpls-exp值，范围0-7，当enableRemarkMplsExp为true时生效。	6
enableStatistic	否	boolean	true false	-	是否开启流量统计，默认值false。如果入方向QoS使能，则只能为false。	false
enableWred	否	boolean	true false	-	WRED使能开关,默认值false。 V600R024C00及以上版本FW网关设备支持最高、中等队列优先级配置WRED，V600R021C00及以上版本AR设备支持最高、中等队列优先级配置WRED，V300系列设备支持中等队列优先级配置WRED。如果入方向QoS使能，则只能为false。 WRED仅在队列优先级设置为中时可配置。	false
wredProfileId	否	uuid	-	-	引用的QoS WRED模板Id。	"00000000-0000-0000-0000-000000000000"
wredProfileName	否	string	1~64个字符。	-	引用的QoS WRED模板名称。	"wredProfileName"
enableQueueLength	否	boolean	true false	-	是否开启队列长度设置,默认值false。如果入方向QoS使能，则只能为false。开启队列长度需要先使能队列优先级。如果配置为true，queueByteLength和queuePacketLength至少配一个。	false
queueByteLength	否	int32	-	-	队列字节长度，范围2048～2097152。AR6700系列（不包含AR6710-L14T2X4）和AR8700系列只支持配置queueByteLength。 enableQueuePriority和EnableQueueLength同时为true时，queueByteLength、queuePacketLength之一必须填。	3000
queuePacketLength	否	int32	-	-	队列包大小长度，范围1～1024。AR8140、AR6700V-L、AR6710-L14T2X4和XH6710-H12T10X4只支持配置queuePacketLength的值为512和1024； enableQueuePriority和EnableQueueLength同时为true时，queueByteLength、queuePacketLength之一必须填。按向上取整原则：[1,512]->512，[513,1024]->1024进行转换。 AR6700系列（不包含AAR6710-L14T2X4）和AR8700系列只支持配置bytes。	10
wanEnable	否	boolean	true false	true	WAN侧使能，默认打开WAN侧使能。与lanEnable字段不能同时为true或者false。	true
lanEnable	否	boolean	true false	false	LAN侧使能，使能后只能配置DSCP标记和统计开关，默认关闭LAN侧使能。与wanEnable字段不能同时为true或者false。	false
tcpOptimization	否	REFERENCE	详细请参见表7。		TCP单边优化参数。该字段暂不支持。	-
weightFixEnable	否	boolean	true false	false	权重固定使能开关，默认关闭。仅支持队列优先级priorityLevel配置为中等medium时配置。仅支持动态QoS场景配置，V600版本设备仅支持V600R024C00及以上版本的AR8000系列及AR6710-H4T4X2Y7系列设备，V300版本设备不支持。	false

表6 InboundCarInfo对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
enableInboundQos	否	boolean	true false	false	是否配置入方向QoS参数。如果配置为true，cirValue和cirPercentage至少配一个，pirValue和pirPercentage至少配一个。	false
cirValue	否	double	[0.01-100000]	-	保证带宽（Mbps），不能和cirPercentage同时配置。必须和pirValue同时配置且需小于或者等于pirValue。同一个站点同一个VPN下cirValue之和不能超过该VPN的带宽，如果该VPN下既有配置cirValue又有配置cirPercentage，则cirValue与cirPercentage之和不能超过该VPN的带宽。仅入方向QoS有效。 V300系列设备支持最大值为10000，最小取值范围0.01；V600R022C00及之后版本的设备支持最大值为100000，最小取值范围0.024；可精确到三位小数。	1
cirPercentage	否	int32	[1-99]	-	保证带宽，百分比形式，范围1-99，不能和cirValue同时配置。必须和pirPercentage同时配置且需小于或者等于pirPercentage。同一个站点同一个VPN下cirPercentage必须小于100，如果该VPN下既有配置cirPercentage又有配置cirValue，则cirValue与cirPercentage之和不能超过该VPN的带宽。仅入方向QoS有效。	10
pirValue	否	double	[0.01-100000]	-	限制带宽（Mbps），不能和pirPercentage同时配置。仅入方向QoS有效。 V300系列设备支持最大值为10000，最小取值范围0.01；V600R022C00及之后版本的设备支持最大值为100000，最小取值范围0.024；可精确到三位小数。 Pir限制带宽不能小于Cir限制带宽。	1
pirPercentage	否	int32	[1-99]	-	限制带宽，百分比形式，范围1-99，不能和pirValue同时配置。必须和cirPercentage同时配置。仅入方向QoS有效。 Pir限制带宽不能小于Cir限制带宽。	10

表7 TcpOptimizationInfo对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
enableTcpOptimization	否	boolean	true false	false	TCP单边优化开关，默认关闭。该字段暂不支持。	false
congestionControlAlgorithm	否	string	-	BBR	拥塞控制算法（BBR/HCC）,默认BBR。固网/专线推荐使用BBR，无线/LTE/5G推荐使用HCC。该字段暂不支持。	"BBR"
sendBufferMax	否	integer	[1-6000]	6000	发送缓存（kB）。默认最大值6000。该字段暂不支持。	6000

请求示例

HTTP的示例

POST /controller/campus/v1/sdwan/policy/traffic/behavior-profile HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
	"trafficBehaviors" : [
		{
			"id" : "00000000-0000-0000-0000-000000000000",
			"name" : "templateName",
			"type" : "qos",
			"redirectInfo" : {
				"nextHopType" : "ip",
				"nextHop" : "192.168.2.254",
				"nextHopSiteId" : "000000-0000-0000-0000-000000000000",
				"nextHopSiteName" : "site",
				"trackIp" : "192.168.2.2",
				"backupNextHop" : "192.168.2.224",
				"backupNextHopSiteId" : "000000-0000-0000-0000-000000000000",
				"backupNextHopSiteName" : "site",
				"backupTrackIp" : "192.168.2.222"
			},
			"qosInfo" : {
				"id" : "00000000-0000-0000-0000-000000000000",
				"name" : "templateName",
				"inboundCar" : {
					"enableInboundQos" : false,
					"cirValue" : 1,
					"cirPercentage" : 10,
					"pirValue" : 1,
					"pirPercentage" : 10
				},
				"enableQueuePriority" : false,
				"priorityLevel" : "highest",
				"guaranteedBandwidthValue" : 1,
				"guaranteedBandwidthPercentage" : 10,
				"enableBandwidthLimit" : false,
				"limitType" : "CAR",
				"limitBandwidthValue" : 1,
				"limitBandwidthPeakValue" : 1,
				"limitBandwidthPercentage" : 10,
				"enableRemarkDscp" : false,
				"remarkDscpValue" : 10,
				"enableRemark8021p" : false,
				"remark8021pValue" : 1,
				"enableRemarkMplsExp" : false,
				"remarkMplsExpValue" : 6,
				"enableStatistic" : false,
				"enableWred" : false,
				"wredProfileId" : "00000000-0000-0000-0000-000000000000",
				"wredProfileName" : "wredProfileName",
				"enableQueueLength" : false,
				"queueByteLength" : 3000,
				"queuePacketLength" : 10,
				"wanEnable" : true,
				"lanEnable" : false,
				"tcpOptimization" : {
					"enableTcpOptimization" : false,
					"congestionControlAlgorithm" : "BBR",
					"sendBufferMax" : 6000
				},
				"weightFixEnable" : false
			}
		}
	]
}

响应参数

返回状态码为201：创建成功，响应体参考TrafficBehaviorResponse。

表8 TrafficBehaviorResponse对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
errcode	string	-	-	错误码：0 表示接口执行成功，非0 表示接口执行失败。	"0"
errmsg	string	-	-	错误信息。	""
success	ARRAY_REFERENCE	0-1000个列表项，详细请参见表9。		成功的行为模板信息列表。	-
fail	ARRAY_REFERENCE	0-1000个列表项，详细请参见表14。		失败的策略行为模板信息列表。	-

表9 TrafficBehaviorInfo对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
id	uuid	-	-	策略行为模板ID，修改或删除的时候必填。主键字段。	"00000000-0000-0000-0000-000000000000"
name	string	1~64个字符。	-	模板名称，创建的时候必填。该参数唯一。不支持特殊字符。模板名称由汉字、小写字母、大写字母、数字、下划线或短横线组成的字符串。	"templateName"
type	string	1~64个字符。	-	模板类型，必填参数。取值范围：redirect、qos（不区分大小写），redirect表示重定向行为模板，qos表示qos行为模板。	"qos"
redirectInfo	REFERENCE	详细请参见表10。		redirect的行为模板结构体。type类型为redirect时，redirectInfo生效。	-
qosInfo	REFERENCE	详细请参见表11。		Qos的行为模板结构体，id和name使用外层结构体的，qosInfo中无需填写。type类型为qos时，qosInfo生效。	-

**表10** RedirectInfo对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
nextHopType	string	0~10个字符。满足正则表达^(ip\|tenantSite\|mspSite)$。	ip	重定向下一跳支持的类型，ip：IP地址类型，tenantSite：租户站点类型，mspSite：MSP站点类型，默认为ip。仅V600R024C00及之后版本的AR设备(不包括AR6700V-L)支持配置tenantSite、mspSite类型。	"ip"
nextHop	string	0~64个字符。	-	主重定向下一跳IP地址，支持IPv4、IPv6，与backupNextHop的IP地址不能相同。 nextHopType为ip时有效，且nextHopType为ip时创建必填。 V300系列设备仅V300R022C10及以上版本支持配置IPv6类型地址，V600系列设备仅V600R022C10及以上版本支持配置IPv6类型地址。	"192.168.2.254"
nextHopSiteId	string	0~36个字符。	-	主重定向下一跳站点ID，与backupNextHopSiteId不能相同。 nextHopType为tenantSite、mspSite时有效，且nextHopType为tenantSite、mspSite时创建必填。	"000000-0000-0000-0000-000000000000"
nextHopSiteName	string	0~64个字符。	-	主重定向下一跳站点名称。仅查询接口使用。	"site"
trackIp	string	0~64个字符。	-	主重定向探测IP地址，支持IPv4，与backupTrackIp的IP地址不能相同。 nextHopType为ip时有效。	"192.168.2.2"
backupNextHop	string	0~64个字符。	-	备重定向下一跳IP地址，支持IPv4，与nextHop的IP地址不能相同。 nextHopType为ip时有效。	"192.168.2.224"
backupNextHopSiteId	string	0~36个字符。	-	备重定向下一跳站点ID，与nextHopSiteId不能相同。 nextHopType为tenantSite、mspSite时有效。	"000000-0000-0000-0000-000000000000"
backupNextHopSiteName	string	0~64个字符。	-	备重定向下一跳站点名称。仅查询接口使用。	"site"
backupTrackIp	string	0~64个字符。	-	备重定向探测IP地址，支持IPv4，与trackIp地址不能相同。 nextHopType为ip时有效。	"192.168.2.222"

**表11** QosProfileInfo对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
id	uuid	-	-	模板ID，主键字段。修改或删除的时候必填。	"00000000-0000-0000-0000-000000000000"
name	string	1~64个字符。满足正则表达^[\u4e00-\u9fa5a-zA-Z0-9_-]+$。	-	模板名称，只能包含汉字、字母、数字、下划线和横线。调用批量创建QoS模板接口时必填，该参数唯一。调用策略行为模板接口时，仅做返回值使用。	"templateName"
inboundCar	REFERENCE	详细请参见表12。		入方向QoS的Car结构体。	-
enableQueuePriority	boolean	true false	false	是否开启队列优先级。 enableQueuePriority和enableBandwidthLimit至少有一个为true。如果入方向QoS使能，则只能为false。如果配置为true，priorityLevel必填，guaranteedBandwidthValue和guaranteedBandwidthPercentage至少配置一个。 V600系列设备必须开启队列优先级。	false
priorityLevel	string	4~7个字符。	-	队列优先级，取值范围：highest、high、medium（不区分大小写），highest表示最高，high表示高，medium表示中等。 V300系列设备支持highest、high、medium,V600系列设备只支持highest、medium。当priorityLevel为medium时，V600系列设备必须配置guaranteedBandwidthPercentage。当priorityLevel为highest时，V600系列设备配置guaranteedBandwidthValue或guaranteedBandwidthPercentage不生效。	"highest"
guaranteedBandwidthValue	double	[0.01-10000]	-	保证带宽（Mbps），不能和guaranteedBandwidthPercentage同时存在。	1
guaranteedBandwidthPercentage	int32	-	-	保证带宽，百分比形式，范围1-99，不能和guaranteedBandwidthValue同时存在。同一个VPN同一个站点下guaranteedBandwidthPercentage之和建议小于100。只有在队列优先级使能的情况下，才能配置队列的长度（字节或包）。	10
enableBandwidthLimit	boolean	true false	false	是否开启带宽限制。 enableQueuePriority和enableBandwidthLimit至少有一个为true。如果配置为true，limitType必填，limitBandwidthValue和limitBandwidthPercentage至少配一个。如果入方向QoS使能，则只能为false。	false
limitType	string	3~7个字符。	-	带宽限制类型，该字段可以设置为以下几种： a) CAR：流量监管 b) Shaping：流量整形 V600系列设备仅V600R022C00及以上的版本支持流量监管。	"CAR"
limitBandwidthValue	double	[0.01-100000]	-	限制带宽（Mbps），不能和limitBandwidthPercentage同时存在。 V300系列设备支持最大值为10000，最小值为0.01。V600系列设备支持最大值为100000，最小值为0.024。	1
limitBandwidthPeakValue	double	[0.01-10000]	-	该字段已废弃。限制带宽（Mbps）峰值流量速率，只对入方向QOS有效。取值必须大于等于limitBandwidthValue，缺省等于limitBandwidthValue。	1
limitBandwidthPercentage	int32	-	-	限制带宽，百分比形式，范围1-99，不能和limitBandwidthValue同时存在。	10
enableRemarkDscp	boolean	true false	-	是否重新标记DSCP值,默认值为false。如果入方向QoS使能，V600版本的设备不支持DSCP标记，如果配置为true，remarkDscpValue必填。	false
remarkDscpValue	int32	[0-63]	-	重新标记的DSCP值，范围0-63，当enableRemarkDscp为true时生效。	10
enableRemark8021p	boolean	true false	-	是否重新标记8021P值，默认值为false。如果入方向QoS使能，则只能为false。如果配置为true，remark8021pValue必填。	false
remark8021pValue	int32	[0-7]	-	重新标记的8021P值，范围0-7，当enableRemark8021p为true时生效。	1
enableRemarkMplsExp	boolean	true false	-	是否重新标记mpls-exp值，默认值为false。如果入方向QoS使能，则只能为false。 V600系列设备只能为false。如果配置为true，remarkMplsExpValue必填。	false
remarkMplsExpValue	int32	[0-7]	-	重新标记的mpls-exp值，范围0-7，当enableRemarkMplsExp为true时生效。	6
enableStatistic	boolean	true false	-	是否开启流量统计，默认值false。如果入方向QoS使能，则只能为false。	false
enableWred	boolean	true false	-	WRED使能开关,默认值false。 V600R024C00及以上版本FW网关设备支持最高、中等队列优先级配置WRED，V600R021C00及以上版本AR设备支持最高、中等队列优先级配置WRED，V300系列设备支持中等队列优先级配置WRED。如果入方向QoS使能，则只能为false。 WRED仅在队列优先级设置为中时可配置。	false
wredProfileId	uuid	-	-	引用的QoS WRED模板Id。	"00000000-0000-0000-0000-000000000000"
wredProfileName	string	1~64个字符。	-	引用的QoS WRED模板名称。	"wredProfileName"
enableQueueLength	boolean	true false	-	是否开启队列长度设置,默认值false。如果入方向QoS使能，则只能为false。开启队列长度需要先使能队列优先级。如果配置为true，queueByteLength和queuePacketLength至少配一个。	false
queueByteLength	int32	-	-	队列字节长度，范围2048～2097152。AR6700系列（不包含AR6710-L14T2X4）和AR8700系列只支持配置queueByteLength。 enableQueuePriority和EnableQueueLength同时为true时，queueByteLength、queuePacketLength之一必须填。	3000
queuePacketLength	int32	-	-	队列包大小长度，范围1～1024。AR8140、AR6700V-L、AR6710-L14T2X4和XH6710-H12T10X4只支持配置queuePacketLength的值为512和1024； enableQueuePriority和EnableQueueLength同时为true时，queueByteLength、queuePacketLength之一必须填。按向上取整原则：[1,512]->512，[513,1024]->1024进行转换。 AR6700系列（不包含AAR6710-L14T2X4）和AR8700系列只支持配置bytes。	10
wanEnable	boolean	true false	true	WAN侧使能，默认打开WAN侧使能。与lanEnable字段不能同时为true或者false。	true
lanEnable	boolean	true false	false	LAN侧使能，使能后只能配置DSCP标记和统计开关，默认关闭LAN侧使能。与wanEnable字段不能同时为true或者false。	false
tcpOptimization	REFERENCE	详细请参见表13。		TCP单边优化参数。该字段暂不支持。	-
weightFixEnable	boolean	true false	false	权重固定使能开关，默认关闭。仅支持队列优先级priorityLevel配置为中等medium时配置。仅支持动态QoS场景配置，V600版本设备仅支持V600R024C00及以上版本的AR8000系列及AR6710-H4T4X2Y7系列设备，V300版本设备不支持。	false

**表12** InboundCarInfo对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
enableInboundQos	boolean	true false	false	是否配置入方向QoS参数。如果配置为true，cirValue和cirPercentage至少配一个，pirValue和pirPercentage至少配一个。	false
cirValue	double	[0.01-100000]	-	保证带宽（Mbps），不能和cirPercentage同时配置。必须和pirValue同时配置且需小于或者等于pirValue。同一个站点同一个VPN下cirValue之和不能超过该VPN的带宽，如果该VPN下既有配置cirValue又有配置cirPercentage，则cirValue与cirPercentage之和不能超过该VPN的带宽。仅入方向QoS有效。 V300系列设备支持最大值为10000，最小取值范围0.01；V600R022C00及之后版本的设备支持最大值为100000，最小取值范围0.024；可精确到三位小数。	1
cirPercentage	int32	[1-99]	-	保证带宽，百分比形式，范围1-99，不能和cirValue同时配置。必须和pirPercentage同时配置且需小于或者等于pirPercentage。同一个站点同一个VPN下cirPercentage必须小于100，如果该VPN下既有配置cirPercentage又有配置cirValue，则cirValue与cirPercentage之和不能超过该VPN的带宽。仅入方向QoS有效。	10
pirValue	double	[0.01-100000]	-	限制带宽（Mbps），不能和pirPercentage同时配置。仅入方向QoS有效。 V300系列设备支持最大值为10000，最小取值范围0.01；V600R022C00及之后版本的设备支持最大值为100000，最小取值范围0.024；可精确到三位小数。 Pir限制带宽不能小于Cir限制带宽。	1
pirPercentage	int32	[1-99]	-	限制带宽，百分比形式，范围1-99，不能和pirValue同时配置。必须和cirPercentage同时配置。仅入方向QoS有效。 Pir限制带宽不能小于Cir限制带宽。	10

**表13** TcpOptimizationInfo对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
enableTcpOptimization	boolean	true false	false	TCP单边优化开关，默认关闭。该字段暂不支持。	false
congestionControlAlgorithm	string	-	BBR	拥塞控制算法（BBR/HCC）,默认BBR。固网/专线推荐使用BBR，无线/LTE/5G推荐使用HCC。该字段暂不支持。	"BBR"
sendBufferMax	integer	[1-6000]	6000	发送缓存（kB）。默认最大值6000。该字段暂不支持。	6000

**表14** FailTrafficBehaviorInfo对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
errcode	string	-	-	错误码。	"0x00c8000c"
errmsg	string	-	-	错误信息。	"The parameter is invalid."
data	REFERENCE	详细请参见表9。		失败的策略行为模板信息。	-

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

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

返回状态码为500：内部错误。

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

响应示例

返回状态码为201：创建成功，响应体参考TrafficBehaviorResponse。

HTTP/1.1 201 Created
Date: Sun,16 Feb 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
	"errcode" : "0",
	"errmsg" : "",
	"success" : [
		{
			"id" : "00000000-0000-0000-0000-000000000000",
			"name" : "templateName",
			"type" : "qos",
			"redirectInfo" : {
				"nextHopType" : "ip",
				"nextHop" : "192.168.2.254",
				"nextHopSiteId" : "000000-0000-0000-0000-000000000000",
				"nextHopSiteName" : "site",
				"trackIp" : "192.168.2.2",
				"backupNextHop" : "192.168.2.224",
				"backupNextHopSiteId" : "000000-0000-0000-0000-000000000000",
				"backupNextHopSiteName" : "site",
				"backupTrackIp" : "192.168.2.222"
			},
			"qosInfo" : {
				"id" : "00000000-0000-0000-0000-000000000000",
				"name" : "templateName",
				"inboundCar" : {
					"enableInboundQos" : false,
					"cirValue" : 1,
					"cirPercentage" : 10,
					"pirValue" : 1,
					"pirPercentage" : 10
				},
				"enableQueuePriority" : false,
				"priorityLevel" : "highest",
				"guaranteedBandwidthValue" : 1,
				"guaranteedBandwidthPercentage" : 10,
				"enableBandwidthLimit" : false,
				"limitType" : "CAR",
				"limitBandwidthValue" : 1,
				"limitBandwidthPeakValue" : 1,
				"limitBandwidthPercentage" : 10,
				"enableRemarkDscp" : false,
				"remarkDscpValue" : 10,
				"enableRemark8021p" : false,
				"remark8021pValue" : 1,
				"enableRemarkMplsExp" : false,
				"remarkMplsExpValue" : 6,
				"enableStatistic" : false,
				"enableWred" : false,
				"wredProfileId" : "00000000-0000-0000-0000-000000000000",
				"wredProfileName" : "wredProfileName",
				"enableQueueLength" : false,
				"queueByteLength" : 3000,
				"queuePacketLength" : 10,
				"wanEnable" : true,
				"lanEnable" : false,
				"tcpOptimization" : {
					"enableTcpOptimization" : false,
					"congestionControlAlgorithm" : "BBR",
					"sendBufferMax" : 6000
				},
				"weightFixEnable" : false
			}
		}
	],
	"fail" : [
		{
			"errcode" : "0x00c8000c",
			"errmsg" : "The parameter is invalid.",
			"data" : {
				"id" : "00000000-0000-0000-0000-000000000000",
				"name" : "templateName",
				"type" : "qos",
				"redirectInfo" : {
					"nextHopType" : "ip",
					"nextHop" : "192.168.2.254",
					"nextHopSiteId" : "000000-0000-0000-0000-000000000000",
					"nextHopSiteName" : "site",
					"trackIp" : "192.168.2.2",
					"backupNextHop" : "192.168.2.224",
					"backupNextHopSiteId" : "000000-0000-0000-0000-000000000000",
					"backupNextHopSiteName" : "site",
					"backupTrackIp" : "192.168.2.222"
				},
				"qosInfo" : {
					"id" : "00000000-0000-0000-0000-000000000000",
					"name" : "templateName",
					"inboundCar" : {
						"enableInboundQos" : false,
						"cirValue" : 1,
						"cirPercentage" : 10,
						"pirValue" : 1,
						"pirPercentage" : 10
					},
					"enableQueuePriority" : false,
					"priorityLevel" : "highest",
					"guaranteedBandwidthValue" : 1,
					"guaranteedBandwidthPercentage" : 10,
					"enableBandwidthLimit" : false,
					"limitType" : "CAR",
					"limitBandwidthValue" : 1,
					"limitBandwidthPeakValue" : 1,
					"limitBandwidthPercentage" : 10,
					"enableRemarkDscp" : false,
					"remarkDscpValue" : 10,
					"enableRemark8021p" : false,
					"remark8021pValue" : 1,
					"enableRemarkMplsExp" : false,
					"remarkMplsExpValue" : 6,
					"enableStatistic" : false,
					"enableWred" : false,
					"wredProfileId" : "00000000-0000-0000-0000-000000000000",
					"wredProfileName" : "wredProfileName",
					"enableQueueLength" : false,
					"queueByteLength" : 3000,
					"queuePacketLength" : 10,
					"wanEnable" : true,
					"lanEnable" : false,
					"tcpOptimization" : {
						"enableTcpOptimization" : false,
						"congestionControlAlgorithm" : "BBR",
						"sendBufferMax" : 6000
					},
					"weightFixEnable" : false
				}
			}
		}
	]
}

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

HTTP/1.1 400 Bad Request
Date: Sun,16 Feb 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive

返回状态码为500：内部错误。

HTTP/1.1 500 Internal Server Error
Date: Sun,16 Feb 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive

批量创建策略行为模板

典型场景

接口功能

接口约束

调用方法

URI

请求参数

请求示例

响应参数

响应示例

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈