DescribeBgpPeers

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

调用说明

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

调试

请求参数

返回数据

BgpPeer

请求示例

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的错误码，更多错误码请参见公共错误码。