文档

DescribeBgpPeers - 查询指定地域下的BGP邻居

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeBgpPeersRead
  • VirtualBorderRouter
    acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}

请求参数

名称类型必填描述示例值
RouterIdstring

要查询的 BGP 邻居关联的 VBR ID。

vbr-2zecmmvg5gvu8i4te****
BgpPeerIdstring

要查询的 BGP 邻居的 ID。

bgp-2ze3un0ft1jd1xd****
BgpGroupIdstring

要查询的 BGP 邻居所在 BGP 组的 ID。

bgpg-2zev8h2wo414sfh****
RegionIdstring

要查询的 BGP 邻居所在 BGP 组的地域 ID。

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

cn-shanghai
IsDefaultboolean

是否是默认 BGP 组。取值:

  • true:是默认 BGP 组。

  • false:不是默认 BGP 组。

false
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

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

10

返回参数

名称类型描述示例值
object

BGP 邻居详细信息。

PageSizeinteger

分页查询时每页的行数。

10
RequestIdstring

请求 ID。

DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
PageNumberinteger

列表的页码。

1
TotalCountinteger

列表条目数。

10
BgpPeersarray<object>

查询的 BGP 邻居的详细信息。

object

查询的 BGP 邻居的详细信息。

Statusstring

BGP 邻居的状态。取值:

  • Pending:待定。

  • Available:可用。

  • Modifying:修改中。

  • Deleting:删除中。

  • Deleted:已删除。

Available
PeerIpAddressstring

BGP 邻居的 IP 地址。

116.62.XX.XX
RouterIdstring

路由器的 ID。

vbr-2zecmmvg5gvu8i4te****
BgpGroupIdstring

BGP 组的 ID。

bgpg-2zev8h2wo414sfh****
BgpStatusstring

BGP 的连接状态。取值:

  • Idle:未连接。
  • Connect:使用中。
  • Active:可用。
  • Established:已建立。
  • Down:不可用。
Connect
BfdMultiHopinteger

BFD 跳数。

3
PeerAsnstring

BGP 邻居的 AS 号。

65515
LocalAsnstring

阿里云侧设备 AS 号。

45104
RegionIdstring

BGP 组所属的地域 ID。

cn-shanghai
BgpPeerIdstring

BGP 邻居的 ID。

bgp-2ze3un0ft1jd1xd****
EnableBfdboolean

是否开启 BFD 协议。取值:

  • true:开启 BFD 协议。
  • false:未开启 BFD 协议。
true
Holdstring

保持时间。

30
IpVersionstring

IP 版本。

ipv4
Keepalivestring

保活时间。

10
Descriptionstring

BGP 组的描述信息。

test
RouteLimitstring

路由限制。

110
IsFakeboolean

是否启用 Fake AS 号。取值:

  • true:启用 Fake AS 号。
  • false:未启用 Fake AS 号。
true
AuthKeystring

BGP 组的认证密钥。

!PWZ****
Namestring

BGP 邻居的名称。

test
AdvertisedRouteCountinteger

宣告的路由数。

0
ReceivedRouteCountinteger

接收的路由数。

0
GmtModifiedstring

BGP 邻居的修改时间。

2022-05-20T07:29:08Z

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
  "PageNumber": 1,
  "TotalCount": 10,
  "BgpPeers": {
    "BgpPeer": [
      {
        "Status": "Available",
        "PeerIpAddress": "116.62.XX.XX",
        "RouterId": "vbr-2zecmmvg5gvu8i4te****",
        "BgpGroupId": "bgpg-2zev8h2wo414sfh****",
        "BgpStatus": "Connect",
        "BfdMultiHop": 3,
        "PeerAsn": "65515",
        "LocalAsn": "45104",
        "RegionId": "cn-shanghai",
        "BgpPeerId": "bgp-2ze3un0ft1jd1xd****",
        "EnableBfd": true,
        "Hold": "30",
        "IpVersion": "ipv4",
        "Keepalive": "10",
        "Description": "test",
        "RouteLimit": "110",
        "IsFake": true,
        "AuthKey": "!PWZ****",
        "Name": "test",
        "AdvertisedRouteCount": 0,
        "ReceivedRouteCount": 0,
        "GmtModified": "2022-05-20T07:29:08Z"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ServiceUnavailableThe request has failed due to a temporary failure of the server.请求失败,因为临时服务器故障。
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.指定的RegionId不存在。
500InternalErrorThe request processing has failed due to some unknown error.请求处理由于某些未知错误失败。

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

变更历史

变更时间变更内容概要操作
2024-05-08OpenAPI 错误码发生变更查看变更详情
2023-09-11OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2021-11-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情