专线连接
专线连接
文档指南
请输入
- 文档首页
专线连接API参考BGP邻居DescribeBgpPeers - 查询BGP邻居列表
复制全文
下载 pdfDescribeBgpPeers - 查询BGP邻居列表
文档反馈
问问助手调用DescribeBgpPeers查询符合要求的BGP邻居的详细信息。
使用说明
- 若请求参数不传入BgpPeerIds，则会按照传入的其他参数查询，返回符合条件的BGP邻居。
- 若请求参数中的非必选参数都不传入，则会按照当前登录账户查询，返回当前账户下的所有BGP邻居。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action String 必选 示例值：DescribeBgpPeers
接口名称。当前 API 的名称为 DescribeBgpPeers。
Version String 必选 示例值：2020-04-01
接口版本。当前 API 的版本为 2020-04-01。
BgpPeerIds.N String 可选 示例值：bgp-7qthudw0ll6jmc****
BGP邻居的ID。
- 参数 - N：表示BGP邻居ID的序号，单次调用数量上限100个。
- 多个BGP邻居ID之间用&分隔。
BgpPeerName String 可选 示例值：test
BGP邻居的名称。
VirtualInterfaceId String 可选 示例值：dcv-3tehy13n2l4c6c0v****
BGP邻居所在虚拟接口的ID。
DirectConnectGatewayId String 可选 示例值：dcg-7qthudw0ll6jmc****
BGP邻居所属专线网关的ID。
RemoteAsn Integer 可选 示例值：32500
BGP邻居的对端ASN。
PageNumber Integer 可选 示例值：1
列表的页码。
- 如需传入此参数，请传入非负整数。
- 不传或传入0，则均默认为1。
PageSize Integer 可选 示例值：20
分页查询时每页的行数。最大值为100，默认值为20。
返回参数
TotalCount Integer 示例值：10
满足指定条件的BGP邻居总数。
PageNumber Integer 示例值：1
当前页码。
PageSize Integer 示例值：20
当前分页的行数。
BgpPeers Object[] 示例值：-
BGP邻居的详细信息。
Status String 示例值：Available
BGP邻居的状态。
- Creating: 创建中
- Deleting: 删除中
- Pending：配置中
- Available：可用
AuthKey String 示例值：mypass***
BGP邻居的认证密钥。
LocalAsn Integer 示例值：137718
火山侧的ASN号。
AccountId String 示例值：20******57
资源归属账号的ID。
BgpPeerId String 示例值：bgp-274oahfm8gjy87fap8tpn6n1c
BGP邻居的ID。
IpVersion String 示例值：IPv4
BGP邻居的IP类型。
- IPv4
- IPv6
RemoteAsn Integer 示例值：20031
BGP邻居的对端ASN。
UpdateTime String 示例值：2021-12-07T15:57:22+08:00
更新BGP邻居的时间。
BgpPeerName String 示例值：test-bgp
BGP邻居的名称。
Description String 示例值：test bgp for idc
BGP邻居的描述。
CreationTime String 示例值：2021-12-07T15:57:22+08:00
创建BGP邻居的时间。
SessionStatus String 示例值：Up
BGP连接的状态。
- Up：正常
- Down：故障
VirtualInterfaceId String 示例值：dcv-2752hyf6****
BGP邻居所在虚拟接口的ID。
请求示例
返回示例
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | LimitExceeded.BgpPeerId | You've reached the limit on the number of BGP peer IDs that you can describe. | 已达到可查询的BGP邻居ID数量上限。 |
400 | InvalidPage.Malformed | The specified page is malformed. | 指定的分页参数不合法。 |
最近更新时间：2026.01.23 17:00:40
这个页面对您有帮助吗？
有用
有用
无用
无用