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

volcengine.direct_connect.getVirtualInterfaces

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 virtual interfaces

    Example Usage

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

const foo = volcengine.direct_connect.getVirtualInterfaces({
    virtualInterfaceName: "tf-test",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.direct_connect.get_virtual_interfaces(virtual_interface_name="tf-test")

    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.GetVirtualInterfaces(ctx, &direct_connect.GetVirtualInterfacesArgs{
			VirtualInterfaceName: pulumi.StringRef("tf-test"),
		}, 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.GetVirtualInterfaces.Invoke(new()
    {
        VirtualInterfaceName = "tf-test",
    });

});

    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.GetVirtualInterfacesArgs;
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.getVirtualInterfaces(GetVirtualInterfacesArgs.builder()
            .virtualInterfaceName("tf-test")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:direct_connect:getVirtualInterfaces
      Arguments:
        virtualInterfaceName: tf-test

    Using getVirtualInterfaces

    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 getVirtualInterfaces(args: GetVirtualInterfacesArgs, opts?: InvokeOptions): Promise<GetVirtualInterfacesResult>
function getVirtualInterfacesOutput(args: GetVirtualInterfacesOutputArgs, opts?: InvokeOptions): Output<GetVirtualInterfacesResult>
    def get_virtual_interfaces(direct_connect_connection_id: Optional[str] = None,
                           direct_connect_gateway_id: Optional[str] = None,
                           ids: Optional[Sequence[str]] = None,
                           local_ip: Optional[str] = None,
                           name_regex: Optional[str] = None,
                           output_file: Optional[str] = None,
                           peer_ip: Optional[str] = None,
                           route_type: Optional[str] = None,
                           tag_filters: Optional[Sequence[GetVirtualInterfacesTagFilter]] = None,
                           virtual_interface_name: Optional[str] = None,
                           vlan_id: Optional[int] = None,
                           opts: Optional[InvokeOptions] = None) -> GetVirtualInterfacesResult
def get_virtual_interfaces_output(direct_connect_connection_id: Optional[pulumi.Input[str]] = None,
                           direct_connect_gateway_id: Optional[pulumi.Input[str]] = None,
                           ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                           local_ip: Optional[pulumi.Input[str]] = None,
                           name_regex: Optional[pulumi.Input[str]] = None,
                           output_file: Optional[pulumi.Input[str]] = None,
                           peer_ip: Optional[pulumi.Input[str]] = None,
                           route_type: Optional[pulumi.Input[str]] = None,
                           tag_filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVirtualInterfacesTagFilterArgs]]]] = None,
                           virtual_interface_name: Optional[pulumi.Input[str]] = None,
                           vlan_id: Optional[pulumi.Input[int]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetVirtualInterfacesResult]
    func GetVirtualInterfaces(ctx *Context, args *GetVirtualInterfacesArgs, opts ...InvokeOption) (*GetVirtualInterfacesResult, error)
func GetVirtualInterfacesOutput(ctx *Context, args *GetVirtualInterfacesOutputArgs, opts ...InvokeOption) GetVirtualInterfacesResultOutput

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

    public static class GetVirtualInterfaces 
{
    public static Task<GetVirtualInterfacesResult> InvokeAsync(GetVirtualInterfacesArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualInterfacesResult> Invoke(GetVirtualInterfacesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVirtualInterfacesResult> getVirtualInterfaces(GetVirtualInterfacesArgs args, InvokeOptions options)
public static Output<GetVirtualInterfacesResult> getVirtualInterfaces(GetVirtualInterfacesArgs args, InvokeOptions options)

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

    The following arguments are supported:

    DirectConnectConnectionId string
    The direct connect connection ID that associated with this virtual interface.
    DirectConnectGatewayId string
    The direct connect gateway ID that associated with this virtual interface.
    Ids List<string>
    A list of IDs.
    LocalIp string
    The local IP that associated with this virtual interface.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    PeerIp string
    The peer IP that associated with this virtual interface.
    RouteType string
    The route type of virtual interface.
    TagFilters List<GetVirtualInterfacesTagFilter>
    The filter tag of direct connect virtual interface.
    VirtualInterfaceName string
    The name of virtual interface.
    VlanId int
    The VLAN ID of virtual interface.
    DirectConnectConnectionId string
    The direct connect connection ID that associated with this virtual interface.
    DirectConnectGatewayId string
    The direct connect gateway ID that associated with this virtual interface.
    Ids []string
    A list of IDs.
    LocalIp string
    The local IP that associated with this virtual interface.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    PeerIp string
    The peer IP that associated with this virtual interface.
    RouteType string
    The route type of virtual interface.
    TagFilters []GetVirtualInterfacesTagFilter
    The filter tag of direct connect virtual interface.
    VirtualInterfaceName string
    The name of virtual interface.
    VlanId int
    The VLAN ID of virtual interface.
    directConnectConnectionId String
    The direct connect connection ID that associated with this virtual interface.
    directConnectGatewayId String
    The direct connect gateway ID that associated with this virtual interface.
    ids List<String>
    A list of IDs.
    localIp String
    The local IP that associated with this virtual interface.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    peerIp String
    The peer IP that associated with this virtual interface.
    routeType String
    The route type of virtual interface.
    tagFilters List<GetVirtualInterfacesTagFilter>
    The filter tag of direct connect virtual interface.
    virtualInterfaceName String
    The name of virtual interface.
    vlanId Integer
    The VLAN ID of virtual interface.
    directConnectConnectionId string
    The direct connect connection ID that associated with this virtual interface.
    directConnectGatewayId string
    The direct connect gateway ID that associated with this virtual interface.
    ids string[]
    A list of IDs.
    localIp string
    The local IP that associated with this virtual interface.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    peerIp string
    The peer IP that associated with this virtual interface.
    routeType string
    The route type of virtual interface.
    tagFilters GetVirtualInterfacesTagFilter[]
    The filter tag of direct connect virtual interface.
    virtualInterfaceName string
    The name of virtual interface.
    vlanId number
    The VLAN ID of virtual interface.
    direct_connect_connection_id str
    The direct connect connection ID that associated with this virtual interface.
    direct_connect_gateway_id str
    The direct connect gateway ID that associated with this virtual interface.
    ids Sequence[str]
    A list of IDs.
    local_ip str
    The local IP that associated with this virtual interface.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    peer_ip str
    The peer IP that associated with this virtual interface.
    route_type str
    The route type of virtual interface.
    tag_filters Sequence[GetVirtualInterfacesTagFilter]
    The filter tag of direct connect virtual interface.
    virtual_interface_name str
    The name of virtual interface.
    vlan_id int
    The VLAN ID of virtual interface.
    directConnectConnectionId String
    The direct connect connection ID that associated with this virtual interface.
    directConnectGatewayId String
    The direct connect gateway ID that associated with this virtual interface.
    ids List<String>
    A list of IDs.
    localIp String
    The local IP that associated with this virtual interface.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    peerIp String
    The peer IP that associated with this virtual interface.
    routeType String
    The route type of virtual interface.
    tagFilters List<Property Map>
    The filter tag of direct connect virtual interface.
    virtualInterfaceName String
    The name of virtual interface.
    vlanId Number
    The VLAN ID of virtual interface.

    getVirtualInterfaces Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    VirtualInterfaces List<GetVirtualInterfacesVirtualInterface>
    The collection of query.
    DirectConnectConnectionId string
    The direct connect connection ID which associated with this virtual interface.
    DirectConnectGatewayId string
    The direct connect gateway ID which associated with this virtual interface.
    Ids List<string>
    LocalIp string
    The local IP that associated with this virtual interface.
    NameRegex string
    OutputFile string
    PeerIp string
    The peer IP that associated with this virtual interface.
    RouteType string
    The route type of this virtual interface.
    TagFilters List<GetVirtualInterfacesTagFilter>
    VirtualInterfaceName string
    The name of virtual interface.
    VlanId int
    The VLAN ID of virtual interface.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    VirtualInterfaces []GetVirtualInterfacesVirtualInterface
    The collection of query.
    DirectConnectConnectionId string
    The direct connect connection ID which associated with this virtual interface.
    DirectConnectGatewayId string
    The direct connect gateway ID which associated with this virtual interface.
    Ids []string
    LocalIp string
    The local IP that associated with this virtual interface.
    NameRegex string
    OutputFile string
    PeerIp string
    The peer IP that associated with this virtual interface.
    RouteType string
    The route type of this virtual interface.
    TagFilters []GetVirtualInterfacesTagFilter
    VirtualInterfaceName string
    The name of virtual interface.
    VlanId int
    The VLAN ID of virtual interface.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    virtualInterfaces List<GetVirtualInterfacesVirtualInterface>
    The collection of query.
    directConnectConnectionId String
    The direct connect connection ID which associated with this virtual interface.
    directConnectGatewayId String
    The direct connect gateway ID which associated with this virtual interface.
    ids List<String>
    localIp String
    The local IP that associated with this virtual interface.
    nameRegex String
    outputFile String
    peerIp String
    The peer IP that associated with this virtual interface.
    routeType String
    The route type of this virtual interface.
    tagFilters List<GetVirtualInterfacesTagFilter>
    virtualInterfaceName String
    The name of virtual interface.
    vlanId Integer
    The VLAN ID of virtual interface.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    virtualInterfaces GetVirtualInterfacesVirtualInterface[]
    The collection of query.
    directConnectConnectionId string
    The direct connect connection ID which associated with this virtual interface.
    directConnectGatewayId string
    The direct connect gateway ID which associated with this virtual interface.
    ids string[]
    localIp string
    The local IP that associated with this virtual interface.
    nameRegex string
    outputFile string
    peerIp string
    The peer IP that associated with this virtual interface.
    routeType string
    The route type of this virtual interface.
    tagFilters GetVirtualInterfacesTagFilter[]
    virtualInterfaceName string
    The name of virtual interface.
    vlanId number
    The VLAN ID of virtual interface.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    virtual_interfaces Sequence[GetVirtualInterfacesVirtualInterface]
    The collection of query.
    direct_connect_connection_id str
    The direct connect connection ID which associated with this virtual interface.
    direct_connect_gateway_id str
    The direct connect gateway ID which associated with this virtual interface.
    ids Sequence[str]
    local_ip str
    The local IP that associated with this virtual interface.
    name_regex str
    output_file str
    peer_ip str
    The peer IP that associated with this virtual interface.
    route_type str
    The route type of this virtual interface.
    tag_filters Sequence[GetVirtualInterfacesTagFilter]
    virtual_interface_name str
    The name of virtual interface.
    vlan_id int
    The VLAN ID of virtual interface.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    virtualInterfaces List<Property Map>
    The collection of query.
    directConnectConnectionId String
    The direct connect connection ID which associated with this virtual interface.
    directConnectGatewayId String
    The direct connect gateway ID which associated with this virtual interface.
    ids List<String>
    localIp String
    The local IP that associated with this virtual interface.
    nameRegex String
    outputFile String
    peerIp String
    The peer IP that associated with this virtual interface.
    routeType String
    The route type of this virtual interface.
    tagFilters List<Property Map>
    virtualInterfaceName String
    The name of virtual interface.
    vlanId Number
    The VLAN ID of virtual interface.

    Supporting Types

    GetVirtualInterfacesTagFilter

    Key string
    The tag key of cloud resource instance.
    Value string
    The tag value of cloud resource instance.
    Key string
    The tag key of cloud resource instance.
    Value string
    The tag value of cloud resource instance.
    key String
    The tag key of cloud resource instance.
    value String
    The tag value of cloud resource instance.
    key string
    The tag key of cloud resource instance.
    value string
    The tag value of cloud resource instance.
    key str
    The tag key of cloud resource instance.
    value str
    The tag value of cloud resource instance.
    key String
    The tag key of cloud resource instance.
    value String
    The tag value of cloud resource instance.

    GetVirtualInterfacesVirtualInterface

    AccountId string
    The account ID which this virtual interface belongs.
    Bandwidth int
    The band width limit of virtual interface,in Mbps.
    BfdDetectInterval int
    The BFD detect interval.
    BfdDetectMultiplier int
    The BFD detect times.
    CreationTime string
    The creation time of virtual interface.
    Description string
    The description of the virtual interface.
    DirectConnectConnectionId string
    The direct connect connection ID that associated with this virtual interface.
    DirectConnectGatewayId string
    The direct connect gateway ID that associated with this virtual interface.
    EnableBfd bool
    Whether enable BFD detect.
    EnableNqa bool
    Whether enable NQA detect.
    LocalIp string
    The local IP that associated with this virtual interface.
    NqaDetectInterval int
    The NQA detect interval.
    NqaDetectMultiplier int
    The NAQ detect times.
    PeerIp string
    The peer IP that associated with this virtual interface.
    RouteType string
    The route type of virtual interface.
    Status string
    The status of virtaul interface.
    Tags List<GetVirtualInterfacesVirtualInterfaceTag>
    The tags that direct connect gateway added.
    UpdateTime string
    The update time of virtual interface.
    VirtualInterfaceId string
    The virtual interface ID.
    VirtualInterfaceName string
    The name of virtual interface.
    VlanId int
    The VLAN ID of virtual interface.
    AccountId string
    The account ID which this virtual interface belongs.
    Bandwidth int
    The band width limit of virtual interface,in Mbps.
    BfdDetectInterval int
    The BFD detect interval.
    BfdDetectMultiplier int
    The BFD detect times.
    CreationTime string
    The creation time of virtual interface.
    Description string
    The description of the virtual interface.
    DirectConnectConnectionId string
    The direct connect connection ID that associated with this virtual interface.
    DirectConnectGatewayId string
    The direct connect gateway ID that associated with this virtual interface.
    EnableBfd bool
    Whether enable BFD detect.
    EnableNqa bool
    Whether enable NQA detect.
    LocalIp string
    The local IP that associated with this virtual interface.
    NqaDetectInterval int
    The NQA detect interval.
    NqaDetectMultiplier int
    The NAQ detect times.
    PeerIp string
    The peer IP that associated with this virtual interface.
    RouteType string
    The route type of virtual interface.
    Status string
    The status of virtaul interface.
    Tags []GetVirtualInterfacesVirtualInterfaceTag
    The tags that direct connect gateway added.
    UpdateTime string
    The update time of virtual interface.
    VirtualInterfaceId string
    The virtual interface ID.
    VirtualInterfaceName string
    The name of virtual interface.
    VlanId int
    The VLAN ID of virtual interface.
    accountId String
    The account ID which this virtual interface belongs.
    bandwidth Integer
    The band width limit of virtual interface,in Mbps.
    bfdDetectInterval Integer
    The BFD detect interval.
    bfdDetectMultiplier Integer
    The BFD detect times.
    creationTime String
    The creation time of virtual interface.
    description String
    The description of the virtual interface.
    directConnectConnectionId String
    The direct connect connection ID that associated with this virtual interface.
    directConnectGatewayId String
    The direct connect gateway ID that associated with this virtual interface.
    enableBfd Boolean
    Whether enable BFD detect.
    enableNqa Boolean
    Whether enable NQA detect.
    localIp String
    The local IP that associated with this virtual interface.
    nqaDetectInterval Integer
    The NQA detect interval.
    nqaDetectMultiplier Integer
    The NAQ detect times.
    peerIp String
    The peer IP that associated with this virtual interface.
    routeType String
    The route type of virtual interface.
    status String
    The status of virtaul interface.
    tags List<GetVirtualInterfacesVirtualInterfaceTag>
    The tags that direct connect gateway added.
    updateTime String
    The update time of virtual interface.
    virtualInterfaceId String
    The virtual interface ID.
    virtualInterfaceName String
    The name of virtual interface.
    vlanId Integer
    The VLAN ID of virtual interface.
    accountId string
    The account ID which this virtual interface belongs.
    bandwidth number
    The band width limit of virtual interface,in Mbps.
    bfdDetectInterval number
    The BFD detect interval.
    bfdDetectMultiplier number
    The BFD detect times.
    creationTime string
    The creation time of virtual interface.
    description string
    The description of the virtual interface.
    directConnectConnectionId string
    The direct connect connection ID that associated with this virtual interface.
    directConnectGatewayId string
    The direct connect gateway ID that associated with this virtual interface.
    enableBfd boolean
    Whether enable BFD detect.
    enableNqa boolean
    Whether enable NQA detect.
    localIp string
    The local IP that associated with this virtual interface.
    nqaDetectInterval number
    The NQA detect interval.
    nqaDetectMultiplier number
    The NAQ detect times.
    peerIp string
    The peer IP that associated with this virtual interface.
    routeType string
    The route type of virtual interface.
    status string
    The status of virtaul interface.
    tags GetVirtualInterfacesVirtualInterfaceTag[]
    The tags that direct connect gateway added.
    updateTime string
    The update time of virtual interface.
    virtualInterfaceId string
    The virtual interface ID.
    virtualInterfaceName string
    The name of virtual interface.
    vlanId number
    The VLAN ID of virtual interface.
    account_id str
    The account ID which this virtual interface belongs.
    bandwidth int
    The band width limit of virtual interface,in Mbps.
    bfd_detect_interval int
    The BFD detect interval.
    bfd_detect_multiplier int
    The BFD detect times.
    creation_time str
    The creation time of virtual interface.
    description str
    The description of the virtual interface.
    direct_connect_connection_id str
    The direct connect connection ID that associated with this virtual interface.
    direct_connect_gateway_id str
    The direct connect gateway ID that associated with this virtual interface.
    enable_bfd bool
    Whether enable BFD detect.
    enable_nqa bool
    Whether enable NQA detect.
    local_ip str
    The local IP that associated with this virtual interface.
    nqa_detect_interval int
    The NQA detect interval.
    nqa_detect_multiplier int
    The NAQ detect times.
    peer_ip str
    The peer IP that associated with this virtual interface.
    route_type str
    The route type of virtual interface.
    status str
    The status of virtaul interface.
    tags Sequence[GetVirtualInterfacesVirtualInterfaceTag]
    The tags that direct connect gateway added.
    update_time str
    The update time of virtual interface.
    virtual_interface_id str
    The virtual interface ID.
    virtual_interface_name str
    The name of virtual interface.
    vlan_id int
    The VLAN ID of virtual interface.
    accountId String
    The account ID which this virtual interface belongs.
    bandwidth Number
    The band width limit of virtual interface,in Mbps.
    bfdDetectInterval Number
    The BFD detect interval.
    bfdDetectMultiplier Number
    The BFD detect times.
    creationTime String
    The creation time of virtual interface.
    description String
    The description of the virtual interface.
    directConnectConnectionId String
    The direct connect connection ID that associated with this virtual interface.
    directConnectGatewayId String
    The direct connect gateway ID that associated with this virtual interface.
    enableBfd Boolean
    Whether enable BFD detect.
    enableNqa Boolean
    Whether enable NQA detect.
    localIp String
    The local IP that associated with this virtual interface.
    nqaDetectInterval Number
    The NQA detect interval.
    nqaDetectMultiplier Number
    The NAQ detect times.
    peerIp String
    The peer IP that associated with this virtual interface.
    routeType String
    The route type of virtual interface.
    status String
    The status of virtaul interface.
    tags List<Property Map>
    The tags that direct connect gateway added.
    updateTime String
    The update time of virtual interface.
    virtualInterfaceId String
    The virtual interface ID.
    virtualInterfaceName String
    The name of virtual interface.
    vlanId Number
    The VLAN ID of virtual interface.

    GetVirtualInterfacesVirtualInterfaceTag

    Key string
    The tag key.
    Value string
    The tag value.
    Key string
    The tag key.
    Value string
    The tag value.
    key String
    The tag key.
    value String
    The tag value.
    key string
    The tag key.
    value string
    The tag value.
    key str
    The tag key.
    value str
    The tag value.
    key String
    The tag key.
    value String
    The tag value.

    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