本文导读

典型场景
接口功能
接口约束
调用方法
URI
请求参数
请求示例
响应参数
响应示例

展开导读

文档首页/ 华为乾坤/ 云管理网络/ API参考/ 接口参考/ LANWAN融合/ 网络编排/ BGP4+路由策略/ 批量创建BGP4+路由peer

批量创建BGP4+路由peer

更新时间：2025-02-17 GMT+08:00

查看PDF

典型场景

BGP4+路由peer北向API。

接口功能

批量创建BGP4+路由peer。

接口约束

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

2.FW网关设备不支持msp视图。

调用方法

POST

URI

/controller/campus/v1/sdwan/routing-protocol/ipv6bgp-peer-info

请求参数

表1 body参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
ipv6BgpRouteInfos	是	REFERENCE	详细请参见表2。		至多支持同一站点两个设备同时创建。	-

表2 Ipv6BgpPeerInfos对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
peerInfos	否	ARRAY_REFERENCE	0-11个列表项，详细请参见表3。		BGP4+路由peer信息。	-

表3 Ipv6BgpPeerInfo对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
siteId	是	uuid	-	-	站点ID，UUID格式。	"fbb684c8-0d37-496f-bafa-4b06d515j7l6"
deviceId	否	uuid	-	-	设备ID，UUID格式。	"fbb684c8-0d37-496f-bafa-4b06d515j7l6"
tnpId	否	uuid	-	-	tnpID，UUID格式。	"fbb684c8-0d37-496f-bafa-4b06d515j7l6"
vpnId	否	uuid	-	-	vpnID，UUID格式。	"fbb684c8-0d37-496f-bafa-4b06d515j7l6"
peers	否	ARRAY_REFERENCE	0-1100个列表项，详细请参见表4。		peer信息。	-

表4 Ipv6PeerInfo对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
Ipv6PeerIp	否	string	0~39个字符。	-	Peer对端IP6地址。	"fc00::1101"
localIp	否	string	0~39个字符。	-	Peer本端IPv6地址。该字段暂不支持。	"fc00::1102"
peerAs	是	string	[1-4294967295]	-	Peer对端BGP As number，取值范围：1-4294967295。	"10"
localAs	否	string	[1-4294967295]	-	Peer本端BGP fake as number，取值范围：1-4294967295。	"10"
allowAsLoop	否	int32	[1-10]	-	配置本地AS号的重复次数。	1
ebgpMaxHop	否	int32	[1-255]	-	配置允许BGP同非直连网络上的对等体建立EBGP连接，并同时可以指定允许的最大跳数。	1
peerIgnore	否	boolean	true false	-	是否禁止与对等体（组）建立会话。Underlay BGP4+路由不支持配置PeerIgnore。	false
keepAliveTime	否	int32	[0-21845]	-	BGP Peer存活时间，keepAliveTime默认值为60。	0
holdTime	否	int32	[0-65535]	-	BGP Peer保持时间，holdTime必须为keepAliveTime的三倍或三倍以上，当keepAliveTime为0时，holdTime必须为0，holdTime默认值为180。	0
md5Encrypt	否	boolean	true false	-	是否加密BGP Peer。默认值为false。	false
md5Key	否	string	1~255个字符。	-	该字段可能包含敏感信息和个人数据，请妥善做好保护。密码必须包含如下规则：-密码长度必须在1~255位。-密码只支持特殊字符、英文大写字母、英文小写字母和数字。-为提高安全性，建议密码至少包含小写字母、大写字母、数字、特殊字符这四种形式中的两种，同时密码长度不小于8个字符。该字段相关配置会下发设备，建议根据设备款型以及版本参考设备资料进行配置。	-
keyChainEnable	否	boolean	true false	false	是否使用keyChain加密。	false
keyChainName	否	string	1~47个字符。	-	keyChain名称。Keychain名称长度范围为1~47个字符，不支持输入中文、中文符号、英文问号、空格、单独"和单独""。当Keychain名称两端使用双引号时，可在Keychain名称中输入空格。	"keyChainName"
bfdEnable	否	boolean	true false	false	是否使能BFD。	false
bfdInfo	否	REFERENCE	详细请参见表5。		BFD参数信息	-
addressFamilys	否	ARRAY_REFERENCE	0-1个列表项，详细请参见表6。		BGP地址族。	-

表5 BfdInfo对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
minTxInterval	否	int32	[10-2000]	1000	指定BFD发送检测报文的时间间隔。 FW网关设备支持的范围为100-1000。 AR6700V-L设备支持的范围为200-2000。不填默认赋值1000。	1000
minRxInterval	否	int32	[10-2000]	1000	指定BFD接收检测报文的间隔。 FW网关设备支持的范围为100-1000。 AR6700V-L设备支持的范围为200-2000。不填默认赋值1000。	1000
detectMultiplier	否	int32	[3-50]	3	指定本地检测时间倍数。不填默认赋值3。	3

表6 Ipv6AddressFamily对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
familyType	否	string	0~16个字符。	-	地址族。取值可以是：ipv6-unicast。	"ipv6-unicast"
advertiseCommunity	否	boolean	true false	-	是否发布Community。	false
exportRoutePolicy	否	REFERENCE	详细请参见表7。		IPv6 BGP路由策略。	-
importRoutePolicy	否	REFERENCE	详细请参见表7。		IPv6 BGP路由策略。	-

表7 Ipv6BgpRoutePolicy对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
nodes	否	ARRAY_REFERENCE	1-100个列表项，详细请参见表8。		路由策略节点。	-

表8 Ipv6BgpPolicyNode对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
nodeIndex	否	int16	[20000-30000]	-	节点序号。	20060
mode	是	string	4~6个字符。	-	黑白名单配置，取值为permit或deny。permit表示白名单，deny表示黑名单。	"permit"
matchCondition	否	REFERENCE	详细请参见表9。		IPv6 路由策略匹配条件。	-
applyAction	否	REFERENCE	详细请参见表14。		路由策略应用的行为。	-
nextNode	否	REFERENCE	详细请参见表20。		Bgp路由策略指向下一节点。	-

表9 Ipv6BgpPolicyNodeMatchCondition对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
ipPrefix	否	REFERENCE	详细请参见表10。		BGP4+ IP前缀。	-
communityFilters	否	ARRAY_REFERENCE	0-8个列表项，详细请参见表12。		团体属性过滤器列表。	-

**表10** Ipv6BgpIpPrefixList对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
name	否	string	0~169个字符。	-	IPv6 前缀名称。该字段暂不支持。	-
prefixFilters	否	ARRAY_REFERENCE	0-100个列表项，详细请参见表11。		IPv6 前缀过滤器。	-

**表11** Ipv6BgpPrefixFilter对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
ipv6Address	否	string	-	-	IPV6地址。	"fc00::1"
maskLength	否	int8	[0-128]	-	掩码	64
greaterEqual	否	int8	[0-128]	-	掩码范围下限。取值范围为：maskLength <= greaterEqual <= lessEqual。	64
lessEqual	否	int8	[0-128]	-	掩码范围上限。取值范围为：maskLength <= greaterEqual <= lessEqual。	64

**表12** BgpCommunityFilter对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
name	否	string	0~51个字符。	-	团体属性过滤器名称。设置wan侧BGP时不可为空，V600设备系列名称符合正则表达式：([^?\s0-9][^?\s]{0,50})\|([\d][^?\s][^?\s0-9][^?\s])，V300设备系列不包含空格、双引号和不支持纯数字。	"bgpCommunityFilterTest"
communityNodes	否	ARRAY_REFERENCE	0-50个列表项，详细请参见表13。		团体属性节点列表。	-
wholeMatch	否	boolean	true false	-	是否全匹配。默认为false。	-

**表13** BgpCommunityNode对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
matchMode	否	string	-	-	匹配模式，取值范围：permit，deny。	"permit"
communityMembers	否	array<string>	0-20 个列表项。	-	团体属性值。成员是数字时，取值范围0-4294967295；成员非数字时要求格式：0～65535:0～65535。	["65520:4555"]

**表14** BgpPolicyNodeApplyAction对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
applyCommunity	否	REFERENCE	详细请参见表15。		Bgp路由策略应用团体属性。修改时不填，则清除配置。	-
applyExtCommunity	否	REFERENCE	详细请参见表16。		Bgp路由策略应用扩展团体属性。修改时不填，则清除配置。	-
applyCommunityDelete	否	REFERENCE	详细请参见表17。		Bgp路由策略应用删除团体属性。仅支持LAN BGP,LAN BGP4+,VPNv4,VPNv6路由策略配置。V300系列设备，V300R019C11之前版本不支持该字段。修改时不填，则清除配置。	-
applyAsPath	否	REFERENCE	详细请参见表18。		AS号路径。修改时不填，则清除配置。	-
applyMetric	否	REFERENCE	详细请参见表19。		Bgp路由策略度量值。修改时不填，则清除配置。	-
localPreference	否	int64	[0-4294967295]	-	本地优先级。数值越小，优先级越高。修改时不填，则清除配置。	100
preferredValue	否	int64	[0-65535]	-	路由首选值。修改时不填，则清除配置。	100

**表15** BgpApplyCommunity对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
communityNumbers	否	array<string>	0-32 个列表项。	-	团体属性数值。值为数字时取值范围：0-4294967290不包含4294967040-4294967044、4294967286-4294967289；值非数字时：0-65535:0-65535，不包含[65535:65280,65535:65284]和[65535:65531,65535:65535]。修改时不填，则清除配置。	["1000"]
additive	否	boolean	true false	false	为true时表示追加到已有的团体属性。该字段暂不支持。	-
none	否	boolean	true false	false	为true时表示清空团体属性。该字段暂不支持。	-

**表16** BgpApplyExtCommunity对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
rtFilters	否	array<string>	0-16 个列表项。	-	扩展团体属性。支持的格式有as-number:nn \| 4as-number:nn \| ipv4-address:nn。	["65520:4552"]
additive	否	boolean	true false	false	为true时表示追加到已有的扩展团体属性，当前只能为true，不支持false。	true

**表17** BgpApplyCommunityDelete对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
communityFilterName	否	string	1~51个字符。	-	团体属性过滤器名称。	"communityTest"

**表18** BgpApplyAsPath对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
asNumbers	否	array<string>	0-10 个列表项。	-	AS号,必填,支持整数形式（as-number-plain）和点分形式（as-number-dot）。整数形式，取值范围是1～4294967295；点分形式格式为x.y，x和y都是整数形式，x的取值范围是1～65535，y的取值范围是0～65535。	["1000"]
additive	否	boolean	true false	false	为true时表示在原有的AS_Path列表中追加指定的AS号。该字段暂不支持。	-
overwrite	否	boolean	true false	false	为true时表示覆盖原有的AS_Path列表。该字段暂不支持。	-
none	否	boolean	true false	false	为true时表示清空原来的AS_Path列表。该字段暂不支持。	-

**表19** BgpApplyMetric对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
cost	否	string	[0-4294967295]	-	路由开销值，取值范围：0-4294967295。	"24"
sign	否	string	0~3个字符。	-	取值范围：add，sub。add表示增加开销值，sub表示减小开销值。该字段暂不支持。	"add"

**表20** BgpPolicyNodeNextNode对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
nextNodeIndex	否	uint16	[20000-30000]	-	继续执行的下一节点的索引值，需要大于nodeIndex。	20080

请求示例

HTTP的示例

POST /controller/campus/v1/sdwan/routing-protocol/ipv6bgp-peer-info 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
{
	"peerInfos" : [
		{
			"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
			"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
			"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
			"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
			"peers" : [
				{
					"Ipv6PeerIp" : "fc00::1101",
					"localIp" : "fc00::1102",
					"peerAs" : "10",
					"localAs" : "10",
					"allowAsLoop" : 1,
					"ebgpMaxHop" : 1,
					"peerIgnore" : false,
					"keepAliveTime" : 0,
					"holdTime" : 0,
					"md5Encrypt" : false,
					"md5Key" : "",
					"keyChainEnable" : false,
					"keyChainName" : "keyChainName",
					"bfdEnable" : false,
					"bfdInfo" : {
						"minTxInterval" : 1000,
						"minRxInterval" : 1000,
						"detectMultiplier" : 3
					},
					"addressFamilys" : [
						{
							"familyType" : "ipv6-unicast",
							"advertiseCommunity" : false,
							"exportRoutePolicy" : {
								"nodes" : [
									{
										"nodeIndex" : 20060,
										"mode" : "permit",
										"matchCondition" : {
											"ipPrefix" : {
												"name" : "",
												"prefixFilters" : [
													{
														"ipv6Address" : "fc00::1",
														"maskLength" : 64,
														"greaterEqual" : 64,
														"lessEqual" : 64
													}
												]
											},
											"communityFilters" : [
												{
													"name" : "bgpCommunityFilterTest",
													"communityNodes" : [
														{
															"matchMode" : "permit",
															"communityMembers" : [
																 "65520:4555"
															]
														}
													],
													"wholeMatch" : ""
												}
											]
										},
										"applyAction" : {
											"applyCommunity" : {
												"communityNumbers" : [
													 "1000"
												],
												"additive" : "",
												"none" : ""
											},
											"applyExtCommunity" : {
												"rtFilters" : [
													 "65520:4552"
												],
												"additive" : true
											},
											"applyCommunityDelete" : {
												"communityFilterName" : "communityTest"
											},
											"applyAsPath" : {
												"asNumbers" : [
													 "1000"
												],
												"additive" : "",
												"overwrite" : "",
												"none" : ""
											},
											"applyMetric" : {
												"cost" : "24",
												"sign" : "add"
											},
											"localPreference" : 100,
											"preferredValue" : 100
										},
										"nextNode" : {
											"nextNodeIndex" : 20080
										}
									}
								]
							},
							"importRoutePolicy" : {
								"nodes" : [
									{
										"nodeIndex" : 20060,
										"mode" : "permit",
										"matchCondition" : {
											"ipPrefix" : {
												"name" : "",
												"prefixFilters" : [
													{
														"ipv6Address" : "fc00::1",
														"maskLength" : 64,
														"greaterEqual" : 64,
														"lessEqual" : 64
													}
												]
											},
											"communityFilters" : [
												{
													"name" : "bgpCommunityFilterTest",
													"communityNodes" : [
														{
															"matchMode" : "permit",
															"communityMembers" : [
																 "65520:4555"
															]
														}
													],
													"wholeMatch" : ""
												}
											]
										},
										"applyAction" : {
											"applyCommunity" : {
												"communityNumbers" : [
													 "1000"
												],
												"additive" : "",
												"none" : ""
											},
											"applyExtCommunity" : {
												"rtFilters" : [
													 "65520:4552"
												],
												"additive" : true
											},
											"applyCommunityDelete" : {
												"communityFilterName" : "communityTest"
											},
											"applyAsPath" : {
												"asNumbers" : [
													 "1000"
												],
												"additive" : "",
												"overwrite" : "",
												"none" : ""
											},
											"applyMetric" : {
												"cost" : "24",
												"sign" : "add"
											},
											"localPreference" : 100,
											"preferredValue" : 100
										},
										"nextNode" : {
											"nextNodeIndex" : 20080
										}
									}
								]
							}
						}
					]
				}
			]
		}
	]
}

响应参数

返回状态码为201：接口调用成功，响应体参考Ipv6BgpRoutePeerResponse。

**表21** Ipv6BgpRoutePeerResponse对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
errcode	string	-	-	错误码。	"0"
errmsg	string	-	-	错误信息。	""
success	ARRAY_REFERENCE	0-2个列表项，详细请参见表22。		BGP4+路由peer配置成功的信息。	-
fail	ARRAY_REFERENCE	0-2个列表项，详细请参见表40。		BGP4+路由peer配置失败的信息。	-

**表22** Ipv6BgpPeerInfo对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
siteId	uuid	-	-	站点ID，UUID格式。	"fbb684c8-0d37-496f-bafa-4b06d515j7l6"
deviceId	uuid	-	-	设备ID，UUID格式。	"fbb684c8-0d37-496f-bafa-4b06d515j7l6"
tnpId	uuid	-	-	tnpID，UUID格式。	"fbb684c8-0d37-496f-bafa-4b06d515j7l6"
vpnId	uuid	-	-	vpnID，UUID格式。	"fbb684c8-0d37-496f-bafa-4b06d515j7l6"
peers	ARRAY_REFERENCE	0-1100个列表项，详细请参见表23。		peer信息。	-

**表23** Ipv6PeerInfo对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
Ipv6PeerIp	string	0~39个字符。	-	Peer对端IP6地址。	"fc00::1101"
localIp	string	0~39个字符。	-	Peer本端IPv6地址。该字段暂不支持。	"fc00::1102"
peerAs	string	[1-4294967295]	-	Peer对端BGP As number，取值范围：1-4294967295。	"10"
localAs	string	[1-4294967295]	-	Peer本端BGP fake as number，取值范围：1-4294967295。	"10"
allowAsLoop	int32	[1-10]	-	配置本地AS号的重复次数。	1
ebgpMaxHop	int32	[1-255]	-	配置允许BGP同非直连网络上的对等体建立EBGP连接，并同时可以指定允许的最大跳数。	1
peerIgnore	boolean	true false	-	是否禁止与对等体（组）建立会话。Underlay BGP4+路由不支持配置PeerIgnore。	false
keepAliveTime	int32	[0-21845]	-	BGP Peer存活时间，keepAliveTime默认值为60。	0
holdTime	int32	[0-65535]	-	BGP Peer保持时间，holdTime必须为keepAliveTime的三倍或三倍以上，当keepAliveTime为0时，holdTime必须为0，holdTime默认值为180。	0
md5Encrypt	boolean	true false	-	是否加密BGP Peer。默认值为false。	false
md5Key	string	1~255个字符。	-	该字段可能包含敏感信息和个人数据，请妥善做好保护。密码必须包含如下规则：-密码长度必须在1~255位。-密码只支持特殊字符、英文大写字母、英文小写字母和数字。-为提高安全性，建议密码至少包含小写字母、大写字母、数字、特殊字符这四种形式中的两种，同时密码长度不小于8个字符。该字段相关配置会下发设备，建议根据设备款型以及版本参考设备资料进行配置。	-
keyChainEnable	boolean	true false	false	是否使用keyChain加密。	false
keyChainName	string	1~47个字符。	-	keyChain名称。Keychain名称长度范围为1~47个字符，不支持输入中文、中文符号、英文问号、空格、单独"和单独""。当Keychain名称两端使用双引号时，可在Keychain名称中输入空格。	"keyChainName"
bfdEnable	boolean	true false	false	是否使能BFD。	false
bfdInfo	REFERENCE	详细请参见表24。		BFD参数信息	-
addressFamilys	ARRAY_REFERENCE	0-1个列表项，详细请参见表25。		BGP地址族。	-

**表24** BfdInfo对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
minTxInterval	int32	[10-2000]	1000	指定BFD发送检测报文的时间间隔。 FW网关设备支持的范围为100-1000。 AR6700V-L设备支持的范围为200-2000。不填默认赋值1000。	1000
minRxInterval	int32	[10-2000]	1000	指定BFD接收检测报文的间隔。 FW网关设备支持的范围为100-1000。 AR6700V-L设备支持的范围为200-2000。不填默认赋值1000。	1000
detectMultiplier	int32	[3-50]	3	指定本地检测时间倍数。不填默认赋值3。	3

**表25** Ipv6AddressFamily对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
familyType	string	0~16个字符。	-	地址族。取值可以是：ipv6-unicast。	"ipv6-unicast"
advertiseCommunity	boolean	true false	-	是否发布Community。	false
exportRoutePolicy	REFERENCE	详细请参见表26。		IPv6 BGP路由策略。	-
importRoutePolicy	REFERENCE	详细请参见表26。		IPv6 BGP路由策略。	-

**表26** Ipv6BgpRoutePolicy对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
nodes	ARRAY_REFERENCE	1-100个列表项，详细请参见表27。		路由策略节点。	-

**表27** Ipv6BgpPolicyNode对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
nodeIndex	int16	[20000-30000]	-	节点序号。	20060
mode	string	4~6个字符。	-	黑白名单配置，取值为permit或deny。permit表示白名单，deny表示黑名单。	"permit"
matchCondition	REFERENCE	详细请参见表28。		IPv6 路由策略匹配条件。	-
applyAction	REFERENCE	详细请参见表33。		路由策略应用的行为。	-
nextNode	REFERENCE	详细请参见表39。		Bgp路由策略指向下一节点。	-

**表28** Ipv6BgpPolicyNodeMatchCondition对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
ipPrefix	REFERENCE	详细请参见表29。		BGP4+ IP前缀。	-
communityFilters	ARRAY_REFERENCE	0-8个列表项，详细请参见表31。		团体属性过滤器列表。	-

**表29** Ipv6BgpIpPrefixList对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
name	string	0~169个字符。	-	IPv6 前缀名称。该字段暂不支持。	-
prefixFilters	ARRAY_REFERENCE	0-100个列表项，详细请参见表30。		IPv6 前缀过滤器。	-

**表30** Ipv6BgpPrefixFilter对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
ipv6Address	string	-	-	IPV6地址。	"fc00::1"
maskLength	int8	[0-128]	-	掩码	64
greaterEqual	int8	[0-128]	-	掩码范围下限。取值范围为：maskLength <= greaterEqual <= lessEqual。	64
lessEqual	int8	[0-128]	-	掩码范围上限。取值范围为：maskLength <= greaterEqual <= lessEqual。	64

**表31** BgpCommunityFilter对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
name	string	0~51个字符。	-	团体属性过滤器名称。设置wan侧BGP时不可为空，V600设备系列名称符合正则表达式：([^?\s0-9][^?\s]{0,50})\|([\d][^?\s][^?\s0-9][^?\s])，V300设备系列不包含空格、双引号和不支持纯数字。	"bgpCommunityFilterTest"
communityNodes	ARRAY_REFERENCE	0-50个列表项，详细请参见表32。		团体属性节点列表。	-
wholeMatch	boolean	true false	-	是否全匹配。默认为false。	-

**表32** BgpCommunityNode对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
matchMode	string	-	-	匹配模式，取值范围：permit，deny。	"permit"
communityMembers	array<string>	0-20 个列表项。	-	团体属性值。成员是数字时，取值范围0-4294967295；成员非数字时要求格式：0～65535:0～65535。	["65520:4555"]

**表33** BgpPolicyNodeApplyAction对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
applyCommunity	REFERENCE	详细请参见表34。		Bgp路由策略应用团体属性。修改时不填，则清除配置。	-
applyExtCommunity	REFERENCE	详细请参见表35。		Bgp路由策略应用扩展团体属性。修改时不填，则清除配置。	-
applyCommunityDelete	REFERENCE	详细请参见表36。		Bgp路由策略应用删除团体属性。仅支持LAN BGP,LAN BGP4+,VPNv4,VPNv6路由策略配置。V300系列设备，V300R019C11之前版本不支持该字段。修改时不填，则清除配置。	-
applyAsPath	REFERENCE	详细请参见表37。		AS号路径。修改时不填，则清除配置。	-
applyMetric	REFERENCE	详细请参见表38。		Bgp路由策略度量值。修改时不填，则清除配置。	-
localPreference	int64	[0-4294967295]	-	本地优先级。数值越小，优先级越高。修改时不填，则清除配置。	100
preferredValue	int64	[0-65535]	-	路由首选值。修改时不填，则清除配置。	100

**表34** BgpApplyCommunity对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
communityNumbers	array<string>	0-32 个列表项。	-	团体属性数值。值为数字时取值范围：0-4294967290不包含4294967040-4294967044、4294967286-4294967289；值非数字时：0-65535:0-65535，不包含[65535:65280,65535:65284]和[65535:65531,65535:65535]。修改时不填，则清除配置。	["1000"]
additive	boolean	true false	false	为true时表示追加到已有的团体属性。该字段暂不支持。	-
none	boolean	true false	false	为true时表示清空团体属性。该字段暂不支持。	-

**表35** BgpApplyExtCommunity对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
rtFilters	array<string>	0-16 个列表项。	-	扩展团体属性。支持的格式有as-number:nn \| 4as-number:nn \| ipv4-address:nn。	["65520:4552"]
additive	boolean	true false	false	为true时表示追加到已有的扩展团体属性，当前只能为true，不支持false。	true

**表36** BgpApplyCommunityDelete对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
communityFilterName	string	1~51个字符。	-	团体属性过滤器名称。	"communityTest"

**表37** BgpApplyAsPath对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
asNumbers	array<string>	0-10 个列表项。	-	AS号,必填,支持整数形式（as-number-plain）和点分形式（as-number-dot）。整数形式，取值范围是1～4294967295；点分形式格式为x.y，x和y都是整数形式，x的取值范围是1～65535，y的取值范围是0～65535。	["1000"]
additive	boolean	true false	false	为true时表示在原有的AS_Path列表中追加指定的AS号。该字段暂不支持。	-
overwrite	boolean	true false	false	为true时表示覆盖原有的AS_Path列表。该字段暂不支持。	-
none	boolean	true false	false	为true时表示清空原来的AS_Path列表。该字段暂不支持。	-

**表38** BgpApplyMetric对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
cost	string	[0-4294967295]	-	路由开销值，取值范围：0-4294967295。	"24"
sign	string	0~3个字符。	-	取值范围：add，sub。add表示增加开销值，sub表示减小开销值。该字段暂不支持。	"add"

**表39** BgpPolicyNodeNextNode对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
nextNodeIndex	uint16	[20000-30000]	-	继续执行的下一节点的索引值，需要大于nodeIndex。	20080

**表40** FailIpv6BgpPeerInfo对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
errcode	string	-	-	错误码。	"0"
errmsg	string	-	-	错误信息。	""
data	REFERENCE	详细请参见表22。		BGP4+路由peer信息。	-

返回状态码为400：校验异常。

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

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

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

响应示例

返回状态码为201：接口调用成功，响应体参考Ipv6BgpRoutePeerResponse。

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" : [
		{
			"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
			"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
			"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
			"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
			"peers" : [
				{
					"Ipv6PeerIp" : "fc00::1101",
					"localIp" : "fc00::1102",
					"peerAs" : "10",
					"localAs" : "10",
					"allowAsLoop" : 1,
					"ebgpMaxHop" : 1,
					"peerIgnore" : false,
					"keepAliveTime" : 0,
					"holdTime" : 0,
					"md5Encrypt" : false,
					"md5Key" : "",
					"keyChainEnable" : false,
					"keyChainName" : "keyChainName",
					"bfdEnable" : false,
					"bfdInfo" : {
						"minTxInterval" : 1000,
						"minRxInterval" : 1000,
						"detectMultiplier" : 3
					},
					"addressFamilys" : [
						{
							"familyType" : "ipv6-unicast",
							"advertiseCommunity" : false,
							"exportRoutePolicy" : {
								"nodes" : [
									{
										"nodeIndex" : 20060,
										"mode" : "permit",
										"matchCondition" : {
											"ipPrefix" : {
												"name" : "",
												"prefixFilters" : [
													{
														"ipv6Address" : "fc00::1",
														"maskLength" : 64,
														"greaterEqual" : 64,
														"lessEqual" : 64
													}
												]
											},
											"communityFilters" : [
												{
													"name" : "bgpCommunityFilterTest",
													"communityNodes" : [
														{
															"matchMode" : "permit",
															"communityMembers" : [
																 "65520:4555"
															]
														}
													],
													"wholeMatch" : ""
												}
											]
										},
										"applyAction" : {
											"applyCommunity" : {
												"communityNumbers" : [
													 "1000"
												],
												"additive" : "",
												"none" : ""
											},
											"applyExtCommunity" : {
												"rtFilters" : [
													 "65520:4552"
												],
												"additive" : true
											},
											"applyCommunityDelete" : {
												"communityFilterName" : "communityTest"
											},
											"applyAsPath" : {
												"asNumbers" : [
													 "1000"
												],
												"additive" : "",
												"overwrite" : "",
												"none" : ""
											},
											"applyMetric" : {
												"cost" : "24",
												"sign" : "add"
											},
											"localPreference" : 100,
											"preferredValue" : 100
										},
										"nextNode" : {
											"nextNodeIndex" : 20080
										}
									}
								]
							},
							"importRoutePolicy" : {
								"nodes" : [
									{
										"nodeIndex" : 20060,
										"mode" : "permit",
										"matchCondition" : {
											"ipPrefix" : {
												"name" : "",
												"prefixFilters" : [
													{
														"ipv6Address" : "fc00::1",
														"maskLength" : 64,
														"greaterEqual" : 64,
														"lessEqual" : 64
													}
												]
											},
											"communityFilters" : [
												{
													"name" : "bgpCommunityFilterTest",
													"communityNodes" : [
														{
															"matchMode" : "permit",
															"communityMembers" : [
																 "65520:4555"
															]
														}
													],
													"wholeMatch" : ""
												}
											]
										},
										"applyAction" : {
											"applyCommunity" : {
												"communityNumbers" : [
													 "1000"
												],
												"additive" : "",
												"none" : ""
											},
											"applyExtCommunity" : {
												"rtFilters" : [
													 "65520:4552"
												],
												"additive" : true
											},
											"applyCommunityDelete" : {
												"communityFilterName" : "communityTest"
											},
											"applyAsPath" : {
												"asNumbers" : [
													 "1000"
												],
												"additive" : "",
												"overwrite" : "",
												"none" : ""
											},
											"applyMetric" : {
												"cost" : "24",
												"sign" : "add"
											},
											"localPreference" : 100,
											"preferredValue" : 100
										},
										"nextNode" : {
											"nextNodeIndex" : 20080
										}
									}
								]
							}
						}
					]
				}
			]
		}
	],
	"fail" : [
		{
			"errcode" : "0",
			"errmsg" : "",
			"data" : {
				"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
				"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
				"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
				"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
				"peers" : [
					{
						"Ipv6PeerIp" : "fc00::1101",
						"localIp" : "fc00::1102",
						"peerAs" : "10",
						"localAs" : "10",
						"allowAsLoop" : 1,
						"ebgpMaxHop" : 1,
						"peerIgnore" : false,
						"keepAliveTime" : 0,
						"holdTime" : 0,
						"md5Encrypt" : false,
						"md5Key" : "",
						"keyChainEnable" : false,
						"keyChainName" : "keyChainName",
						"bfdEnable" : false,
						"bfdInfo" : {
							"minTxInterval" : 1000,
							"minRxInterval" : 1000,
							"detectMultiplier" : 3
						},
						"addressFamilys" : [
							{
								"familyType" : "ipv6-unicast",
								"advertiseCommunity" : false,
								"exportRoutePolicy" : {
									"nodes" : [
										{
											"nodeIndex" : 20060,
											"mode" : "permit",
											"matchCondition" : {
												"ipPrefix" : {
													"name" : "",
													"prefixFilters" : [
														{
															"ipv6Address" : "fc00::1",
															"maskLength" : 64,
															"greaterEqual" : 64,
															"lessEqual" : 64
														}
													]
												},
												"communityFilters" : [
													{
														"name" : "bgpCommunityFilterTest",
														"communityNodes" : [
															{
																"matchMode" : "permit",
																"communityMembers" : [
																	 "65520:4555"
																]
															}
														],
														"wholeMatch" : ""
													}
												]
											},
											"applyAction" : {
												"applyCommunity" : {
													"communityNumbers" : [
														 "1000"
													],
													"additive" : "",
													"none" : ""
												},
												"applyExtCommunity" : {
													"rtFilters" : [
														 "65520:4552"
													],
													"additive" : true
												},
												"applyCommunityDelete" : {
													"communityFilterName" : "communityTest"
												},
												"applyAsPath" : {
													"asNumbers" : [
														 "1000"
													],
													"additive" : "",
													"overwrite" : "",
													"none" : ""
												},
												"applyMetric" : {
													"cost" : "24",
													"sign" : "add"
												},
												"localPreference" : 100,
												"preferredValue" : 100
											},
											"nextNode" : {
												"nextNodeIndex" : 20080
											}
										}
									]
								},
								"importRoutePolicy" : {
									"nodes" : [
										{
											"nodeIndex" : 20060,
											"mode" : "permit",
											"matchCondition" : {
												"ipPrefix" : {
													"name" : "",
													"prefixFilters" : [
														{
															"ipv6Address" : "fc00::1",
															"maskLength" : 64,
															"greaterEqual" : 64,
															"lessEqual" : 64
														}
													]
												},
												"communityFilters" : [
													{
														"name" : "bgpCommunityFilterTest",
														"communityNodes" : [
															{
																"matchMode" : "permit",
																"communityMembers" : [
																	 "65520:4555"
																]
															}
														],
														"wholeMatch" : ""
													}
												]
											},
											"applyAction" : {
												"applyCommunity" : {
													"communityNumbers" : [
														 "1000"
													],
													"additive" : "",
													"none" : ""
												},
												"applyExtCommunity" : {
													"rtFilters" : [
														 "65520:4552"
													],
													"additive" : true
												},
												"applyCommunityDelete" : {
													"communityFilterName" : "communityTest"
												},
												"applyAsPath" : {
													"asNumbers" : [
														 "1000"
													],
													"additive" : "",
													"overwrite" : "",
													"none" : ""
												},
												"applyMetric" : {
													"cost" : "24",
													"sign" : "add"
												},
												"localPreference" : 100,
												"preferredValue" : 100
											},
											"nextNode" : {
												"nextNodeIndex" : 20080
											}
										}
									]
								}
							}
						]
					}
				]
			}
		}
	]
}

返回状态码为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

父主题： BGP4+路由策略

上一篇：批量删除BGP4+路由peer

下一篇：查询BGP4+路由peer

意见反馈

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

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

批量创建BGP4+路由peer

典型场景

接口功能

接口约束

调用方法

URI

请求参数

请求示例

响应参数

响应示例

相关文档

意见反馈

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

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈