接口功能介绍

查询用户专线网关下的BGP动态路由

接口约束

无

URI

GET /v4/cda/bgp-route/list

路径参数

无

Query 参数

参数	是否必填	参数类型	说明	示例	下级对象
vrfName	是	String	专线网关名字

请求参数

请求头 header 参数

无

请求体 body 参数

无

响应参数

参数	参数类型	描述	下级对象
statusCode	Integer	返回状态码(800为成功，900为失败)
message	String	失败时的错误描述，一般为英文描述
description	String	失败时的错误描述，一般为中文描述
returnObj	Object	返回对象	returnObj
errorCode	String	业务细分码，为product.module.code三段式码
error	String	错误
details	String	错误明细

表returnObj

参数	参数类型	说明	示例	下级对象
BGPRouteList	Array of Object	BGP路由列表		BGPRoute

表BGPRoute

参数	参数类型	说明	下级对象
BGPList	Array of Object	IPv4类型的BGP列表	BGP
multiPathNumberIpv6	String	BGP-IPv6多路功能序号(负载线路数)
networkCidr	Array of String	客户侧子网列表(IPv4)
vrfName	String	专线网关名字
multiPathIpv6	Boolean	是否开启BGP-IPv6多路功能
networkCidrV6	Array of String	客户侧子网列表(IPv6)
multiPathType	String	Bgp多路功能类型(IBGP/EBGP)
ipVersion	String	本参数表示包周期类型。取值范围： IPV4 IPV6 DUALSTACK
BGPID	String	BGP ID
BGPIpv6List	Array of Object	IPv6类型的BGP列表	BGP
multiPath	Boolean	是否开启BGP-IPv4多路功能
multiPathNumber	String	BGP-IPv4多路功能序号(负载线路数)

表BGP

参数	参数类型	说明
BGPNeighbor	String	BGP邻居名称
BGPIP	String	BGP邻居IP(物理专线的远端互联IP)
lineID	String	物理专线ID
peerAS	String	Peer AS号
BGPKey	String	BGP密钥
bfd	Boolean	是否打开bfd 功能

请求示例

请求url

/v4/cda/bgp-route/list?vrfName=nm8CTYUN14

请求头

无

请求体 body

无

响应示例

{
	"returnObj": {
		"BGPRouteList": [{
			"BGPList": [{
				"lineID": "",
				"BGPIP": "67.22.60.33",
				"BGPKey": null,
				"bfd": false,
				"peerAS": "3",
				"BGPNeighbor": "bgp-01"
			}],
			"multiPathNumberIpv6": "",
			"networkCidr": ["192.168.10.0/24", "192.168.10.0/24"],
			"gatewayName": "nm8CTYUN14",
			"multiPathIpv6": false,
			"networkCidrV6": [""],
			"multiPathType": null,
			"ipVersion": "IPV4",
			"BGPID": "AGM0YU7QTRKFV3GQ5CN3XLHUYV93",
			"BGPIpv6List": [],
			"multiPath": false,
			"multiPathNumber": ""
		}]
	},
	"errorCode": "",
	"message": "",
	"description": "",
	"statusCode": 800
}

状态码

状态码	描述
800	表示请求成功
900	表示请求未成功

错误码

errorCode	描述
OPENAPI.PatternCheck.NotValid	请求参数无效
OPENAPI.CDA.AccessFailed	内部错误，请重试。如果多次尝试失败，请提交工单

云专线

查询客户侧BGP路由