You need to enable JavaScript to run this app.
导航
专线连接
  • 文档首页
    • /
  • 专线连接

DescribeBgpPeerAttributes

最近更新时间：2024.04.18 19:01:52

首次发布时间：2022.03.25 07:38:20

我的收藏

调用DescribeBgpPeerAttributes查询指定BGP邻居的详细信息。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必选示例值描述
ActionString是DescribeBgpPeerAttributes要执行的操作，取值：DescribeBgpPeerAttributes。
VersionString是2020-04-01API版本信息。
BgpPeerIdString是bgp-2752hz4teko3k7f4c****要查询的BGP邻居的ID。您可调用DescribeBgpPeers查询BGP邻居的ID。

返回数据

名称类型
示例值
描述
RequestIdString2021111616110801021214619****请求ID。
AccountIdString21000*****BGP邻居所属账号的ID。
VirtualInterfaceIdStringdcv-7qthudw0ll6jmc****BGP邻居所在虚拟接口的ID。
BgpPeerIdStringbgp-2752hz4teko3k7f4c****BGP邻居的ID。
BgpPeerNameStringtestBGP邻居的名称。
DescriptionStringThis is a sample descriptionBGP邻居的描述。
CreationTimeString2021-04-09T08:36:47+08:00创建BGP邻居的时间。
UpdateTimeString2021-04-10T09:18:28+08:00更新BGP邻居的时间。
RemoteAsnInteger32000BGP邻居的对端ASN。
AuthKeyStringtestAu****BGP邻居的认证密钥。

Status

String

Available

BGP邻居的状态。

  • Creating: 创建中
  • Deleting: 删除中
  • Pending：配置中
  • Available：可用

SessionStatus

String

Up

BGP邻居的会话状态。

  • Up：正常
  • Down：故障

IpVersion

String

IPv4

BGP邻居的IP类型。

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

请求示例

GET /?Action=DescribeBgpPeerAttributes&Version=2020-04-01&BgpPeerId=bgp-2752hz4teko3k7f4c**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021111616110801021214619****",
        "Action": "DescribeBgpPeerAttributes",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021111616110801021214619****",
        "AccountId":"210000****",
        "BgpPeerId":"bgp-2752hz4teko3k7f4c\*\*\*\*",
        "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
错误码
错误信息
描述
404InvalidBgpPeer.NotFoundThe specified BGP peer does not exist.指定的BGP邻居不存在。