You need to enable JavaScript to run this app.
文档中心
专线连接

专线连接

请输入
  • 文档首页
    • 专线连接API参考BGP邻居DescribeBgpPeerAttributes - 查询BGP邻居
复制全文
下载 pdf
我的收藏
BGP邻居
DescribeBgpPeerAttributes - 查询BGP邻居
复制全文
下载 pdf
我的收藏
DescribeBgpPeerAttributes - 查询BGP邻居
调用DescribeBgpPeerAttributes查询指定BGP邻居的详细信息。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值：DescribeBgpPeerAttributes​
接口名称。当前 API 的名称为 DescribeBgpPeerAttributes。​
​
Version String 必选 示例值：2020-04-01​
接口版本。当前 API 的版本为 2020-04-01。​
​
BgpPeerId String 必选 示例值：bgp-2752hz4teko3k7f4c****​
要查询的BGP邻居的ID。​
您可调用DescribeBgpPeers查询BGP邻居的ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
AccountId String 示例值：21000*****​
BGP邻居所属账号的ID。​
​
VirtualInterfaceId String 示例值：dcv-7qthudw0ll6jmc****​
BGP邻居所在虚拟接口的ID。​
​
BgpPeerId String 示例值：bgp-2752hz4teko3k7f4c****​
BGP邻居的ID。​
​
BgpPeerName String 示例值：test​
BGP邻居的名称。​
​
Description String 示例值：This is a sample description​
BGP邻居的描述。​
​
CreationTime String 示例值：2021-04-09T08:36:47+08:00​
创建BGP邻居的时间。​
​
UpdateTime String 示例值：2021-04-10T09:18:28+08:00​
更新BGP邻居的时间。​
​
RemoteAsn Integer 示例值：32000​
BGP邻居的对端ASN。​
​
AuthKey String 示例值：testAu****​
BGP邻居的认证密钥。​
​
Status String 示例值：Available​
BGP邻居的状态。​
  • Creating: 创建中​
  • Deleting: 删除中​
  • Pending：配置中​
  • Available：可用​
​
SessionStatus String 示例值：Up​
BGP邻居的会话状态。​
  • Up：正常​
  • Down：故障​
​
IpVersion String 示例值：IPv4​
BGP邻居的IP类型。​
  • IPv4​
  • IPv6​
​
LocalAsn Integer 示例值：137718​
火山侧的ASN号。​
​
​
​
请求示例​
​
GET /?Action=DescribeBgpPeerAttributes&Version=2020-04-01&BgpPeerId=bgp-2752hz4teko3k7f4c**** HTTP/1.1​
Host: directconnect.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/directconnect/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"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"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
404​
InvalidBgpPeer.NotFound​
The specified BGP peer does not exist.​
指定的BGP邻居不存在。​
​
​
最近更新时间：2026.01.23 17:00:40
这个页面对您有帮助吗？
有用
有用
无用
无用