Docs

Direct Connect

BGP Peer

DescribeBgpPeerAttributes - Querying a BGP Peer

Call DescribeBgpPeerAttributes to query the details of a specified BGP Peer.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.

Action String required Example: DescribeBgpPeerAttributes

The interface name. The current API name is DescribeBgpPeerAttributes.

Version String required Example: 2020-04-01

The interface version. The current API version is 2020-04-01.

BgpPeerId String requiredExample: bgp-2752hz4teko3k7f4c****

ID of the BGP Peer to be queried.

You can call DescribeBgpPeers to query the BGP Peer ID.

Response parameters

The following only details response parameters specific to this API. For more information, see Response structure.

AccountId String Example: 21000*****

ID of the account to which the BGP Peer belongs.

VirtualInterfaceId String Example: dcv-7qthudw0ll6jmc****

ID of the DC Virtual interface where the BGP Peer is located.

BgpPeerId String Example: bgp-2752hz4teko3k7f4c****

ID of the BGP Peer.

BgpPeerName String Example: test

Name of the BGP Peer.

Description String Example: This is a sample description

Description of the BGP Peer.

CreationTime String Example: 2021-04-09T08:36:47+08:00

The time when the BGP Peer is created.

UpdateTime String Example: 2021-04-10T09:18:28+08:00

The time when the BGP Peer is updated.

RemoteAsn Integer Example: 32000

Remote ASN of the BGP Peer.

AuthKey String Example: testAu****

The authentication key for the BGP Peer.

Status String Example: Available

Status of the BGP Peer.

Creating

Deleting

Pending: Configuration in progress.

Available

SessionStatus String Example: Up

The session status of the BGP Peer.

Up: Healthy

Down: Faulty

IpVersion String Example: IPv4

IP type of the BGP Peer.

IPv4

IPv6

LocalAsn Integer Example: 137718

ASN on the VolcanoEngine side.

Request examples

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​

Response examples

{​
    "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"​
    }​
}​

Error codes

The table below describes the error codes for this API that are associated with business logic. For details, see Common error codes.

Status code	Error codes	Error message	Description
404	InvalidBgpPeer.NotFound	The specified BGP peer does not exist.	The BGP Peer you specified does not exist.

Last updated: 2026.03.06 15:29:55