DescribeBgpGroups - 查询指定地域下的BGP组_高速通道(Express Connect)-阿里云帮助中心

查询指定地域下的BGP组。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RouterId	string	否	BGP 组关联的 VBR 的 ID。	vbr-bp1ctxy813985gkuk****
BgpGroupId	string	否	BGP 组的 ID。	bgpg-bp1k25cyp26cllath****
RegionId	string	是	VBR 所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-shanghai
IsDefault	boolean	否	是否为默认 BGP 组。取值： false：不是默认 BGP 组。 true：是默认 BGP 组。	false
PageNumber	integer	否	列表的页码。默认值：1。	1
PageSize	integer	否	分页查询时每页的行数。最大值：50。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	分页查询时每页的行数。	10
RequestId	string	请求 ID。	1D0971B2-A35A-42C1-A44C-E91360C36C0B
PageNumber	integer	列表的页码。	1
TotalCount	integer	列表条目数。	1
BgpGroups	array<object>	BGP 组的详细信息。
BgpGroup	object
Status	string	BGP 组的状态。	Available
BgpGroupId	string	BGP 组的 ID。	bgpg-bp1k25cyp26cllath****
RouterId	string	VBR 的 ID。	vbr-bp1ctxy813985gkuk****
PeerAsn	string	本地 IDC 侧设备的 AS 号。	1****
LocalAsn	string	阿里云侧 AS 号。	45104
RegionId	string	BGP 组所在地域 ID。	cn-shanghai
Hold	string	等待 BGP 消息传入的保持时间，单位为秒。说明如果超过保持时间还没有消息传入，则认为 BGP 邻居断开了连接。	30
IpVersion	string	BGP 组的 IP 版本。取值： IPv4：IPv4 版本。 IPv6：IPv6 版本，只有当创建 BGP 组的 VBR 开通 IPv6 功能时，支持 IPv6 版本。	IPv4
Description	string	BGP 组的描述信息。	BGP组描述。
Keepalive	string	保活时间，单位为秒。	10
IsFake	string	AS 号是否为假。取值： false：否。 true：是。	true
RouteLimit	string	BGP 动态路由学习的路由条目上限。	99
Name	string	BGP 组的名称。	name
AuthKey	string	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	错误码	错误信息	描述
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	指定参数 OwnerAccount 不合法
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	指定的RegionId不存在。
500	InternalError	The request processing has failed due to some unknown error.	请求处理由于某些未知错误失败。

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

变更历史

变更时间	变更内容概要	操作
2023-09-11	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情