You need to enable JavaScript to run this app.
导航
DescribeBgpPeers
最近更新时间:2024.04.18 19:01:52首次发布时间:2022.03.25 07:38:20

调用DescribeBgpPeers查询符合要求的BGP邻居的详细信息。

调用说明

  • 若请求参数不传入BgpPeerIds,则会按照传入的其他参数查询,返回符合条件的BGP邻居。
  • 若请求参数中的非必选参数都不传入,则会按照当前登录账户查询,返回当前账户下的所有BGP邻居。

调试

请求参数

名称类型是否必选示例值描述
ActionStringDescribeBgpPeers要执行的操作,取值为DescribeBgpPeers。
VersionString2020-04-01API版本信息。

BgpPeerIds.N

List of String

BgpPeerIds.1= bgp-7qthudw0ll6jmc****&BgpPeerIds.2=bgp-13fszmm1xdssg3n6nu4x9****

BGP邻居的ID。

  • 参数 - N:表示BGP邻居ID的序号,单次调用数量上限100个。
  • 多个BGP邻居ID之间用&分隔。
BgpPeerNameStringtestBGP邻居的名称。
VirtualInterfaceIdStringdcv-3tehy13n2l4c6c0v****BGP邻居所在虚拟接口的ID。
DirectConnectGatewayIdStringdcg-7qthudw0ll6jmc****BGP邻居所属专线网关的ID。
RemoteAsnInteger32500BGP邻居的对端ASN。

PageNumber

Integer

1

列表的页码。

  • 如需传入此参数,请传入非负整数。
  • 不传或传入0,则均默认为1。
PageSizeInteger20分页查询时每页的行数。最大值为100,默认值为20。

IpVersion

String

IPv4

BGP邻居的IP类型。

  • IPv4
  • IPv6

返回数据

名称类型
示例值
描述
RequestIdString20211222112033010224****请求ID。
TotalCountInteger10满足指定条件的BGP邻居总数。
PageNumberInteger1当前页码。
PageSizeInteger20当前分页的行数。
BgpPeersArray of struct-BGP邻居的详细信息。具体请参见下表“ BgpPeer ”。

BgpPeer

名称类型
示例值
描述
AccountIdString21000*****BGP邻居所属账号的ID。
BgpPeerIdStringbgp-2752hz4teko3k7f4c****BGP邻居的ID。
BgpPeerNameStringtestBGP邻居的名称。
DescriptionStringThis is a sample descriptionBGP邻居的描述。
VirtualInterfaceIdStringdcv-3tehy13n2l4c6c0v****BGP邻居所在虚拟接口的ID。
RemoteAsnInteger32000BGP邻居的对端ASN。
AuthKeyStringtestAuthBGP邻居的认证密钥。

Status

String

Available

BGP邻居的状态。

  • Creating: 创建中
  • Deleting: 删除中
  • Pending:配置中
  • Available:可用
CreationTimeString2021-04-09T08:36:47+08:00创建BGP邻居的时间。
UpdateTimeString2021-04-10T09:18:28+08:00更新BGP邻居的时间。

SessionStatus

String

Up

BGP连接的状态。

  • Up:正常
  • Down:故障

IpVersion

String

IPv4

BGP邻居的IP类型。

  • IPv4
  • IPv6
LocalAsnInteger137718火山侧的ASN号。

请求示例

GET /?Action=DescribeBgpPeers&Version=2020-04-01&BgpPeerIds.1=bgp-2752hz4teko3k7f4c****&PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211222112033010224****",
        "Action": "DescribeBgpPeers",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20211222112033010224****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "BgpPeers": [
            {
                "BgpPeerId":"bgp-2752hz4teko3k7f4c****",
                "AccountId":"210000****",
                "VirtualInterfaceId": "dcv-7qthudw0ll6jmc****",
                "BgpPeerName": "test",
                "Description": "test",
                "RemoteAsn":32000,
                "AuthKey":"testAuth",
                "Status": "Available",
                "CreationTime": "2021-12-15T17:05:42+08:00",
                "UpdateTime": "2021-12-17T11:50:30+08:00",
                "IpVersion": "IPv4",
                "LocalAsn": 137718,
                "SessionStatus": "Up"
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码,更多错误码请参见公共错误码

HttpCode
错误码
错误信息
描述
400LimitExceeded.BgpPeerIdYou've reached the limit on the number of BGP peer IDs that you can describe.已达到可查询的BGP邻居ID数量上限。
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。