调用DescribeBgpPeers查询指定地域下的BGP邻居。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeBgpPeers

要执行的操作。

取值： DescribeBgpPeers。

RegionId String 是 cn-shanghai

BGP组所在的地域。

您可以通过调用DescribeRegions接口获取地域ID。

RouterId String 否 vbr-2zecmmvg5gvu8i4te****

路由器的ID。
BgpPeerId String 否 bgp-2ze3un0ft1jd1xd*****

BGP邻居的ID。

BgpGroupId String 否 bgpg-2zev8h2wo414sfh******

指定BGP组的ID。
IsDefault Boolean 否 false

是否是默认BGP组。

  • true：是默认BGP组。
  • false：不是默认BGP组。
PageNumber Integer 否 1

列表的页码，默认值为1。

PageSize Integer 否 1

分页查询时每页的行数，最大值为50，默认值为10。

返回数据

名称 类型 示例值 描述
RequestId String DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6

请求ID。
TotalCount Integer 10

列表条条目数。
PageNumber Integer 1

当前页码。
PageSize Integer 2

每页包含多少条目。
BgpPeers Array

BGP邻居的详细信息。
Name String test

BGP邻居的名称。
Description String xxxxxxxxx

BGP组的描述。

BgpPeerId String bgp-wz977wcrmb69agdb******

BGP邻居的ID。
BgpGroupId String bgp-wz977wcrmb69*******

BGP组的ID。
PeerIpAddress String 116.62.**.**

BGP邻居的IP地址。
PeerAsn String active

BGP邻居的ASN。
AuthKey String !PWZ2wsq******

BGP组的认证密钥。
RouterId String vbr-2zecmmvg5gvu8i4te****w

路由器的ID。
BgpStatus String deleted

BGP的连接状态，包含以下状态：

  • creating：创建中。
  • working：使用中。
  • modifying：修改中。
  • deleting：删除中。
  • deleted：已删除。
Status String active

BGP邻居的状态，包括以下状态：

  • Pending：待定。
  • Available：可用。
  • Modifying：修改中。
  • Deleting：删除中。
  • Deleted：已删除。
Keepalive String 10

保活时间。
LocalAsn String 45104

本地ASN号
Hold String 30

保持时间。
IsFake String true

是否启用了Fake AS号。
RouteLimit String 99

路由限制。
RegionId String cn-shanghai

BGP组所属的地域ID。
EnableBfd Boolean true

是否开启了BFD协议。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBgpPeers
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML 格式 

<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<RequestId>16DFA5E6-9771-41B7-B079-DD7C2DF49BE6</RequestId>
<BgpPeers>
    <BgpPeer>
        <BgpGroupId>bgpg-2zev8h2wo414****</BgpGroupId>
        <LocalAsn>45104</LocalAsn>
        <PeerIpAddress>11.11.**.**</PeerIpAddress>
        <Hold>30</Hold>
        <Description/>
        <AuthKey/>
        <IsFake>true</IsFake>
        <PeerAsn>234</PeerAsn>
        <Keepalive>10</Keepalive>
        <RouteLimit>99</RouteLimit>
        <BgpPeerId>bgp-2ze3un0ft1jd1x***</BgpPeerId>
        <Name/>
        <Status>Available</Status>
        <BgpStatus/>
        <RouterId>vbr-2zecmmvg5gvu8i4te****w</RouterId>
        <RegionId>cn-beijing</RegionId>
    </BgpPeer>
    <BgpPeer>
        <BgpGroupId>bgpg-2zev8h2wo414sf****</BgpGroupId>
        <LocalAsn>45104</LocalAsn>
        <PeerIpAddress>11.11.**.**</PeerIpAddress>
        <Hold>30</Hold>
        <Description/>
        <AuthKey/>
        <IsFake>true</IsFake>
        <PeerAsn>234</PeerAsn>
        <Keepalive>10</Keepalive>
        <RouteLimit>99</RouteLimit>
        <BgpPeerId>bgp-2zeu54rbreqqzy*****</BgpPeerId>
        <Name/>
        <Status>Available</Status>
        <BgpStatus/>
        <RouterId>vbr-2zecmmvg5gvu8i*****</RouterId>
        <RegionId>cn-beijing</RegionId>
    </BgpPeer>
</BgpPeers>

JSON 格式 

{
    "TotalCount": 2, 
    "PageSize": 10, 
    "RequestId": "16DFA5E6-9771-41B7-B079-DD7C2DF49BE6", 
    "BgpPeers": {
        "BgpPeer": [
            {
                "BgpGroupId": "bgpg-2zev8h2wo414****", 
                "LocalAsn": 45104, 
                "PeerIpAddress": "11.11.**.**", 
                "Hold": 30, 
                "Description": "", 
                "AuthKey": "", 
                "IsFake": true, 
                "PeerAsn": 234, 
                "Keepalive": 10, 
                "RouteLimit": 99, 
                "BgpPeerId": "bgp-2ze3un0ft1jd1x***", 
                "Name": "", 
                "Status": "Available", 
                "BgpStatus": "", 
                "RouterId": "vbr-2zecmmvg5gvu8i4te****w", 
                "RegionId": "cn-beijing"
            }, 
            {
                "BgpGroupId": "bgpg-2zev8h2wo414sf****", 
                "LocalAsn": 45104, 
                "PeerIpAddress": "11.11.**.**", 
                "Hold": 30, 
                "Description": "", 
                "AuthKey": "", 
                "IsFake": true, 
                "PeerAsn": 234, 
                "Keepalive": 10, 
                "RouteLimit": 99, 
                "BgpPeerId": "bgp-2zeu54rbreqqzy*****", 
                "Name": "", 
                "Status": "Available", 
                "BgpStatus": "", 
                "RouterId": "vbr-2zecmmvg5gvu8i*****", 
                "RegionId": "cn-beijing"
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError The request processing has failed due to some unknown error. 请求处理由于某些未知错误失败。
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. 指定的 RegionId 不存在，请您检查此产品在该地域是否可用。

访问错误中心查看更多错误码。