1. Packages
  2. Volcengine
  3. API Docs
  4. direct_connect
  5. getBgpPeers
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.direct_connect.getBgpPeers

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of direct connect bgp peers

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const foo = volcengine.direct_connect.getBgpPeers({
    ids: ["bgp-171w6pn39ruo04d1w33iq****"],
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.direct_connect.get_bgp_peers(ids=["bgp-171w6pn39ruo04d1w33iq****"])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/direct_connect"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := direct_connect.GetBgpPeers(ctx, &direct_connect.GetBgpPeersArgs{
			Ids: []string{
				"bgp-171w6pn39ruo04d1w33iq****",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Direct_connect.GetBgpPeers.Invoke(new()
    {
        Ids = new[]
        {
            "bgp-171w6pn39ruo04d1w33iq****",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.direct_connect.Direct_connectFunctions;
import com.pulumi.volcengine.direct_connect.inputs.GetBgpPeersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var foo = Direct_connectFunctions.getBgpPeers(GetBgpPeersArgs.builder()
            .ids("bgp-171w6pn39ruo04d1w33iq****")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:direct_connect:getBgpPeers
      Arguments:
        ids:
          - bgp-171w6pn39ruo04d1w33iq****

    Using getBgpPeers

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBgpPeers(args: GetBgpPeersArgs, opts?: InvokeOptions): Promise<GetBgpPeersResult>
function getBgpPeersOutput(args: GetBgpPeersOutputArgs, opts?: InvokeOptions): Output<GetBgpPeersResult>
    def get_bgp_peers(bgp_peer_name: Optional[str] = None,
                  direct_connect_gateway_id: Optional[str] = None,
                  ids: Optional[Sequence[str]] = None,
                  name_regex: Optional[str] = None,
                  output_file: Optional[str] = None,
                  remote_asn: Optional[int] = None,
                  virtual_interface_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetBgpPeersResult
def get_bgp_peers_output(bgp_peer_name: Optional[pulumi.Input[str]] = None,
                  direct_connect_gateway_id: Optional[pulumi.Input[str]] = None,
                  ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  name_regex: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  remote_asn: Optional[pulumi.Input[int]] = None,
                  virtual_interface_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetBgpPeersResult]
    func GetBgpPeers(ctx *Context, args *GetBgpPeersArgs, opts ...InvokeOption) (*GetBgpPeersResult, error)
func GetBgpPeersOutput(ctx *Context, args *GetBgpPeersOutputArgs, opts ...InvokeOption) GetBgpPeersResultOutput

    > Note: This function is named GetBgpPeers in the Go SDK.

    public static class GetBgpPeers 
{
    public static Task<GetBgpPeersResult> InvokeAsync(GetBgpPeersArgs args, InvokeOptions? opts = null)
    public static Output<GetBgpPeersResult> Invoke(GetBgpPeersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBgpPeersResult> getBgpPeers(GetBgpPeersArgs args, InvokeOptions options)
public static Output<GetBgpPeersResult> getBgpPeers(GetBgpPeersArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:direct_connect/getBgpPeers:getBgpPeers
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BgpPeerName string
    The name of bgp peer.
    DirectConnectGatewayId string
    The id of direct connect gateway.
    Ids List<string>
    A list of IDs.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    RemoteAsn int
    The remote asn of bgp peer.
    VirtualInterfaceId string
    The id of virtual interface.
    BgpPeerName string
    The name of bgp peer.
    DirectConnectGatewayId string
    The id of direct connect gateway.
    Ids []string
    A list of IDs.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    RemoteAsn int
    The remote asn of bgp peer.
    VirtualInterfaceId string
    The id of virtual interface.
    bgpPeerName String
    The name of bgp peer.
    directConnectGatewayId String
    The id of direct connect gateway.
    ids List<String>
    A list of IDs.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    remoteAsn Integer
    The remote asn of bgp peer.
    virtualInterfaceId String
    The id of virtual interface.
    bgpPeerName string
    The name of bgp peer.
    directConnectGatewayId string
    The id of direct connect gateway.
    ids string[]
    A list of IDs.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    remoteAsn number
    The remote asn of bgp peer.
    virtualInterfaceId string
    The id of virtual interface.
    bgp_peer_name str
    The name of bgp peer.
    direct_connect_gateway_id str
    The id of direct connect gateway.
    ids Sequence[str]
    A list of IDs.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    remote_asn int
    The remote asn of bgp peer.
    virtual_interface_id str
    The id of virtual interface.
    bgpPeerName String
    The name of bgp peer.
    directConnectGatewayId String
    The id of direct connect gateway.
    ids List<String>
    A list of IDs.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    remoteAsn Number
    The remote asn of bgp peer.
    virtualInterfaceId String
    The id of virtual interface.

    getBgpPeers Result

    The following output properties are available:

    BgpPeers List<GetBgpPeersBgpPeer>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    BgpPeerName string
    The name of bgp peer.
    DirectConnectGatewayId string
    Ids List<string>
    NameRegex string
    OutputFile string
    RemoteAsn int
    The remote asn of bgp peer.
    VirtualInterfaceId string
    The id of virtual interface.
    BgpPeers []GetBgpPeersBgpPeer
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    BgpPeerName string
    The name of bgp peer.
    DirectConnectGatewayId string
    Ids []string
    NameRegex string
    OutputFile string
    RemoteAsn int
    The remote asn of bgp peer.
    VirtualInterfaceId string
    The id of virtual interface.
    bgpPeers List<GetBgpPeersBgpPeer>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    bgpPeerName String
    The name of bgp peer.
    directConnectGatewayId String
    ids List<String>
    nameRegex String
    outputFile String
    remoteAsn Integer
    The remote asn of bgp peer.
    virtualInterfaceId String
    The id of virtual interface.
    bgpPeers GetBgpPeersBgpPeer[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    bgpPeerName string
    The name of bgp peer.
    directConnectGatewayId string
    ids string[]
    nameRegex string
    outputFile string
    remoteAsn number
    The remote asn of bgp peer.
    virtualInterfaceId string
    The id of virtual interface.
    bgp_peers Sequence[GetBgpPeersBgpPeer]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    bgp_peer_name str
    The name of bgp peer.
    direct_connect_gateway_id str
    ids Sequence[str]
    name_regex str
    output_file str
    remote_asn int
    The remote asn of bgp peer.
    virtual_interface_id str
    The id of virtual interface.
    bgpPeers List<Property Map>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    bgpPeerName String
    The name of bgp peer.
    directConnectGatewayId String
    ids List<String>
    nameRegex String
    outputFile String
    remoteAsn Number
    The remote asn of bgp peer.
    virtualInterfaceId String
    The id of virtual interface.

    Supporting Types

    GetBgpPeersBgpPeer

    AccountId string
    The id of account.
    AuthKey string
    The key of auth.
    BgpPeerId string
    The id of bgp peer.
    BgpPeerName string
    The name of bgp peer.
    CreationTime string
    The create time of bgp peer.
    Description string
    The Description of bgp peer.
    LocalAsn int
    The local asn of bgp peer.
    RemoteAsn int
    The remote asn of bgp peer.
    SessionStatus string
    The session status of bgp peer.
    Status string
    The status of bgp peer.
    UpdateTime string
    The update time of bgp peer.
    VirtualInterfaceId string
    The id of virtual interface.
    AccountId string
    The id of account.
    AuthKey string
    The key of auth.
    BgpPeerId string
    The id of bgp peer.
    BgpPeerName string
    The name of bgp peer.
    CreationTime string
    The create time of bgp peer.
    Description string
    The Description of bgp peer.
    LocalAsn int
    The local asn of bgp peer.
    RemoteAsn int
    The remote asn of bgp peer.
    SessionStatus string
    The session status of bgp peer.
    Status string
    The status of bgp peer.
    UpdateTime string
    The update time of bgp peer.
    VirtualInterfaceId string
    The id of virtual interface.
    accountId String
    The id of account.
    authKey String
    The key of auth.
    bgpPeerId String
    The id of bgp peer.
    bgpPeerName String
    The name of bgp peer.
    creationTime String
    The create time of bgp peer.
    description String
    The Description of bgp peer.
    localAsn Integer
    The local asn of bgp peer.
    remoteAsn Integer
    The remote asn of bgp peer.
    sessionStatus String
    The session status of bgp peer.
    status String
    The status of bgp peer.
    updateTime String
    The update time of bgp peer.
    virtualInterfaceId String
    The id of virtual interface.
    accountId string
    The id of account.
    authKey string
    The key of auth.
    bgpPeerId string
    The id of bgp peer.
    bgpPeerName string
    The name of bgp peer.
    creationTime string
    The create time of bgp peer.
    description string
    The Description of bgp peer.
    localAsn number
    The local asn of bgp peer.
    remoteAsn number
    The remote asn of bgp peer.
    sessionStatus string
    The session status of bgp peer.
    status string
    The status of bgp peer.
    updateTime string
    The update time of bgp peer.
    virtualInterfaceId string
    The id of virtual interface.
    account_id str
    The id of account.
    auth_key str
    The key of auth.
    bgp_peer_id str
    The id of bgp peer.
    bgp_peer_name str
    The name of bgp peer.
    creation_time str
    The create time of bgp peer.
    description str
    The Description of bgp peer.
    local_asn int
    The local asn of bgp peer.
    remote_asn int
    The remote asn of bgp peer.
    session_status str
    The session status of bgp peer.
    status str
    The status of bgp peer.
    update_time str
    The update time of bgp peer.
    virtual_interface_id str
    The id of virtual interface.
    accountId String
    The id of account.
    authKey String
    The key of auth.
    bgpPeerId String
    The id of bgp peer.
    bgpPeerName String
    The name of bgp peer.
    creationTime String
    The create time of bgp peer.
    description String
    The Description of bgp peer.
    localAsn Number
    The local asn of bgp peer.
    remoteAsn Number
    The remote asn of bgp peer.
    sessionStatus String
    The session status of bgp peer.
    status String
    The status of bgp peer.
    updateTime String
    The update time of bgp peer.
    virtualInterfaceId String
    The id of virtual interface.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate