调用DescribeBgpGroups接口查询的BGP组。

调试

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

请求参数

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

系统规定参数。取值：DescribeBgpGroups。

RouterId String 否 vbr-bp1ctxy813985gkuk****

BGP组关联的VBR的ID。

BgpGroupId String 否 bgpg-bp1k25cyp26cllath****

BGP组的ID。

RegionId String 是 cn-shanghai

VBR所在的地域ID。

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

IsDefault Boolean 否 false

是否为默认BGP组。取值：

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

列表的页码。默认值：1。

PageSize Integer 否 10

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

返回数据

名称 类型 示例值 描述
PageSize Integer 10

分页查询时每页的行数。
RequestId String 1D0971B2-A35A-42C1-A44C-E91360C36C0B

请求ID。
PageNumber Integer 1

列表的页码。
TotalCount Integer 1

列表条目数。
BgpGroups Array of BgpGroup

BGP组的详细信息。
BgpGroup
Status String Available

BGP组的状态。
BgpGroupId String bgpg-bp1k25cyp26cllath****

BGP组的ID。
RouterId String vbr-bp1ctxy813985gkuk****

VBR的ID。
PeerAsn String 1****

本地IDC侧设备的AS号。
LocalAsn String 45104

阿里云侧AS号。
RegionId String cn-shanghai

BGP组所在地域ID。
Hold String 30

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

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

BGP组的IP版本。取值：

  • IPv4：IPv4版本。
  • IPv6：IPv6版本，只有当创建BGP组的VBR开通IPv6功能时，支持IPv6版本。
Description String BGP组描述。

BGP组的描述信息。
Keepalive String 10

保活时间，单位为秒。
IsFake String true

AS号是否为假。取值：

  • false：否。
  • true：是。
RouteLimit String 99

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

BGP组的名称。
AuthKey String !PWZ****

BGP组使用的密钥。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBgpGroups
&RouterId=vbr-bp1ctxy813985gkuk****
&BgpGroupId=bgpg-bp1k25cyp26cllath****
&RegionId=cn-shanghai
&IsDefault=false
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBgpGroupsResponse>
    <PageSize>10</PageSize>
    <RequestId>1D0971B2-A35A-42C1-A44C-E91360C36C0B</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <BgpGroups>
        <Status>Available</Status>
        <BgpGroupId>bgpg-bp1k25cyp26cllath****</BgpGroupId>
        <RouterId>vbr-bp1ctxy813985gkuk****</RouterId>
        <PeerAsn>1****</PeerAsn>
        <LocalAsn>45104</LocalAsn>
        <RegionId>cn-shanghai</RegionId>
        <Hold>30</Hold>
        <IpVersion>ipv4</IpVersion>
        <Description>BGP组描述。</Description>
        <Keepalive>10</Keepalive>
        <IsFake>true</IsFake>
        <RouteLimit>99</RouteLimit>
        <Name>name</Name>
        <AuthKey>!PWZ****</AuthKey>
    </BgpGroups>
</DescribeBgpGroupsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "1D0971B2-A35A-42C1-A44C-E91360C36C0B",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "BgpGroups" : [ {
    "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****"
  } ]
}

错误码

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不存在。

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