文档

DescribeBgpGroups - 查询指定地域下的BGP组

更新时间:

查询指定地域下的BGP组。

调试

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

授权信息

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

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

请求参数

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

BGP 组关联的 VBR 的 ID。

vbr-bp1ctxy813985gkuk****
BgpGroupIdstring

BGP 组的 ID。

bgpg-bp1k25cyp26cllath****
RegionIdstring

VBR 所在的地域 ID。

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

cn-shanghai
IsDefaultboolean

是否为默认 BGP 组。取值:

  • false:不是默认 BGP 组。
  • true:是默认 BGP 组。
false
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

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

10

返回参数

名称类型描述示例值
object
PageSizeinteger

分页查询时每页的行数。

10
RequestIdstring

请求 ID。

1D0971B2-A35A-42C1-A44C-E91360C36C0B
PageNumberinteger

列表的页码。

1
TotalCountinteger

列表条目数。

1
BgpGroupsobject []

BGP 组的详细信息。

Statusstring

BGP 组的状态。

Available
BgpGroupIdstring

BGP 组的 ID。

bgpg-bp1k25cyp26cllath****
RouterIdstring

VBR 的 ID。

vbr-bp1ctxy813985gkuk****
PeerAsnstring

本地 IDC 侧设备的 AS 号。

1****
LocalAsnstring

阿里云侧 AS 号。

45104
RegionIdstring

BGP 组所在地域 ID。

cn-shanghai
Holdstring

等待 BGP 消息传入的保持时间,单位为秒。

说明 如果超过保持时间还没有消息传入,则认为 BGP 邻居断开了连接。
30
IpVersionstring

BGP 组的 IP 版本。取值:

  • IPv4:IPv4 版本。
  • IPv6:IPv6 版本,只有当创建 BGP 组的 VBR 开通 IPv6 功能时,支持 IPv6 版本。
IPv4
Descriptionstring

BGP 组的描述信息。

BGP组描述。
Keepalivestring

保活时间,单位为秒。

10
IsFakestring

AS 号是否为假。取值:

  • false:否。
  • true:是。
true
RouteLimitstring

BGP 动态路由学习的路由条目上限。

99
Namestring

BGP 组的名称。

name
AuthKeystring

BGP 组使用的密钥。

!PWZ****

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "1D0971B2-A35A-42C1-A44C-E91360C36C0B",
  "PageNumber": 1,
  "TotalCount": 1,
  "BgpGroups": {
    "BgpGroup": [
      {
        "Status": "Available",
        "BgpGroupId": "bgpg-bp1k25cyp26cllath****",
        "RouterId": "vbr-bp1ctxy813985gkuk****",
        "PeerAsn": "1****",
        "LocalAsn": "45104",
        "RegionId": "cn-shanghai",
        "Hold": "30",
        "IpVersion": "IPv4",
        "Description": "BGP组描述。",
        "Keepalive": "10",
        "IsFake": "true",
        "RouteLimit": "99",
        "Name": "name",
        "AuthKey": "!PWZ****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400IellgalParameter.OwnerAccountThe specified parameter OwnerAccount is not valid.-
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.指定的RegionId不存在。
500InternalErrorThe request processing has failed due to some unknown error.请求处理由于某些未知错误失败。

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

变更历史

变更时间变更内容概要操作
2023-09-11OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
  • 本页导读 (1)