bytepluscc.directconnect.getVirtualInterface

bytepluscc v0.0.31, Jun 1 26

Viewing docs for bytepluscc v0.0.31
published on Monday, Jun 1, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.31
published on Monday, Jun 1, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getVirtualInterface

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 getVirtualInterface(args: GetVirtualInterfaceArgs, opts?: InvokeOptions): Promise<GetVirtualInterfaceResult>
function getVirtualInterfaceOutput(args: GetVirtualInterfaceOutputArgs, opts?: InvokeOptions): Output<GetVirtualInterfaceResult>

def get_virtual_interface(id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetVirtualInterfaceResult
def get_virtual_interface_output(id: pulumi.Input[Optional[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetVirtualInterfaceResult]

func LookupVirtualInterface(ctx *Context, args *LookupVirtualInterfaceArgs, opts ...InvokeOption) (*LookupVirtualInterfaceResult, error)
func LookupVirtualInterfaceOutput(ctx *Context, args *LookupVirtualInterfaceOutputArgs, opts ...InvokeOption) LookupVirtualInterfaceResultOutput

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

public static class GetVirtualInterface 
{
    public static Task<GetVirtualInterfaceResult> InvokeAsync(GetVirtualInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualInterfaceResult> Invoke(GetVirtualInterfaceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualInterfaceResult> getVirtualInterface(GetVirtualInterfaceArgs args, InvokeOptions options)
public static Output<GetVirtualInterfaceResult> getVirtualInterface(GetVirtualInterfaceArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:directconnect/getVirtualInterface:getVirtualInterface
  arguments:
    # arguments dictionary

data "bytepluscc_directconnect_getvirtualinterface" "name" {
    # arguments
}

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getVirtualInterface Result

The following output properties are available:

AccountId string: ID of the account to which the dedicated line gateway belongs.
Bandwidth int: Bandwidth limit of the virtual interface, in Mbps.
BfdDetectInterval int: BFD detection interval (ms).
BfdDetectMultiplier int: BFD detection count.
CreationTime string: Time when the virtual interface was created.
Description string: Description of the virtual interface.
DirectConnectConnectionId string: ID of the physical dedicated line associated with the virtual interface.
DirectConnectGatewayId string: ID of the dedicated gateway associated with the virtual interface.
EnableBfd bool: Enable BFD detection. true: enabled false: disabled.
EnableBfdEcho bool: Enable BFD detection echo packet mode. true: enabled false: disabled.
EnableNqa bool: Is NQA detection enabled? true: enabled false: not enabled.
Id string: Uniquely identifies the resource.
LocalIp string: Local gateway interconnection IP address of the virtual interface.
LocalIpv6Ip string: IPv6 address of the local gateway interconnection IP for the virtual interface.
NqaDetectInterval int: Interval for sending consecutive probe packets in NQA detection.
NqaDetectMultiplier int: NQA detection count. If the number of consecutive NQA detection failures reaches the set count, the link is considered faulty.
PeerIp string: Peer gateway interconnection IP address of the virtual interface.
PeerIpv6Ip string: IPv6 address of the peer gateway interconnection IP for the virtual interface.
RouteType string: Route type of the virtual interface.
Status string: Status of the virtual interface. Creating: creating Deleting: deleting Pending: configuring Available: available.
Tags List<Byteplus.GetVirtualInterfaceTag>: All tag information added to the virtual interface.
UpdateTime string: Time when the virtual interface was updated.
VirtualInterfaceId string: ID of the virtual interface.
VirtualInterfaceName string: Name of the virtual interface.
VlanId int: VLAN ID of the virtual interface.

AccountId string: ID of the account to which the dedicated line gateway belongs.
Bandwidth int: Bandwidth limit of the virtual interface, in Mbps.
BfdDetectInterval int: BFD detection interval (ms).
BfdDetectMultiplier int: BFD detection count.
CreationTime string: Time when the virtual interface was created.
Description string: Description of the virtual interface.
DirectConnectConnectionId string: ID of the physical dedicated line associated with the virtual interface.
DirectConnectGatewayId string: ID of the dedicated gateway associated with the virtual interface.
EnableBfd bool: Enable BFD detection. true: enabled false: disabled.
EnableBfdEcho bool: Enable BFD detection echo packet mode. true: enabled false: disabled.
EnableNqa bool: Is NQA detection enabled? true: enabled false: not enabled.
Id string: Uniquely identifies the resource.
LocalIp string: Local gateway interconnection IP address of the virtual interface.
LocalIpv6Ip string: IPv6 address of the local gateway interconnection IP for the virtual interface.
NqaDetectInterval int: Interval for sending consecutive probe packets in NQA detection.
NqaDetectMultiplier int: NQA detection count. If the number of consecutive NQA detection failures reaches the set count, the link is considered faulty.
PeerIp string: Peer gateway interconnection IP address of the virtual interface.
PeerIpv6Ip string: IPv6 address of the peer gateway interconnection IP for the virtual interface.
RouteType string: Route type of the virtual interface.
Status string: Status of the virtual interface. Creating: creating Deleting: deleting Pending: configuring Available: available.
Tags []GetVirtualInterfaceTag: All tag information added to the virtual interface.
UpdateTime string: Time when the virtual interface was updated.
VirtualInterfaceId string: ID of the virtual interface.
VirtualInterfaceName string: Name of the virtual interface.
VlanId int: VLAN ID of the virtual interface.

account_id string: ID of the account to which the dedicated line gateway belongs.
bandwidth number: Bandwidth limit of the virtual interface, in Mbps.
bfd_detect_interval number: BFD detection interval (ms).
bfd_detect_multiplier number: BFD detection count.
creation_time string: Time when the virtual interface was created.
description string: Description of the virtual interface.
direct_connect_connection_id string: ID of the physical dedicated line associated with the virtual interface.
direct_connect_gateway_id string: ID of the dedicated gateway associated with the virtual interface.
enable_bfd bool: Enable BFD detection. true: enabled false: disabled.
enable_bfd_echo bool: Enable BFD detection echo packet mode. true: enabled false: disabled.
enable_nqa bool: Is NQA detection enabled? true: enabled false: not enabled.
id string: Uniquely identifies the resource.
local_ip string: Local gateway interconnection IP address of the virtual interface.
local_ipv6_ip string: IPv6 address of the local gateway interconnection IP for the virtual interface.
nqa_detect_interval number: Interval for sending consecutive probe packets in NQA detection.
nqa_detect_multiplier number: NQA detection count. If the number of consecutive NQA detection failures reaches the set count, the link is considered faulty.
peer_ip string: Peer gateway interconnection IP address of the virtual interface.
peer_ipv6_ip string: IPv6 address of the peer gateway interconnection IP for the virtual interface.
route_type string: Route type of the virtual interface.
status string: Status of the virtual interface. Creating: creating Deleting: deleting Pending: configuring Available: available.
tags list(object): All tag information added to the virtual interface.
update_time string: Time when the virtual interface was updated.
virtual_interface_id string: ID of the virtual interface.
virtual_interface_name string: Name of the virtual interface.
vlan_id number: VLAN ID of the virtual interface.

accountId String: ID of the account to which the dedicated line gateway belongs.
bandwidth Integer: Bandwidth limit of the virtual interface, in Mbps.
bfdDetectInterval Integer: BFD detection interval (ms).
bfdDetectMultiplier Integer: BFD detection count.
creationTime String: Time when the virtual interface was created.
description String: Description of the virtual interface.
directConnectConnectionId String: ID of the physical dedicated line associated with the virtual interface.
directConnectGatewayId String: ID of the dedicated gateway associated with the virtual interface.
enableBfd Boolean: Enable BFD detection. true: enabled false: disabled.
enableBfdEcho Boolean: Enable BFD detection echo packet mode. true: enabled false: disabled.
enableNqa Boolean: Is NQA detection enabled? true: enabled false: not enabled.
id String: Uniquely identifies the resource.
localIp String: Local gateway interconnection IP address of the virtual interface.
localIpv6Ip String: IPv6 address of the local gateway interconnection IP for the virtual interface.
nqaDetectInterval Integer: Interval for sending consecutive probe packets in NQA detection.
nqaDetectMultiplier Integer: NQA detection count. If the number of consecutive NQA detection failures reaches the set count, the link is considered faulty.
peerIp String: Peer gateway interconnection IP address of the virtual interface.
peerIpv6Ip String: IPv6 address of the peer gateway interconnection IP for the virtual interface.
routeType String: Route type of the virtual interface.
status String: Status of the virtual interface. Creating: creating Deleting: deleting Pending: configuring Available: available.
tags List<GetVirtualInterfaceTag>: All tag information added to the virtual interface.
updateTime String: Time when the virtual interface was updated.
virtualInterfaceId String: ID of the virtual interface.
virtualInterfaceName String: Name of the virtual interface.
vlanId Integer: VLAN ID of the virtual interface.

accountId string: ID of the account to which the dedicated line gateway belongs.
bandwidth number: Bandwidth limit of the virtual interface, in Mbps.
bfdDetectInterval number: BFD detection interval (ms).
bfdDetectMultiplier number: BFD detection count.
creationTime string: Time when the virtual interface was created.
description string: Description of the virtual interface.
directConnectConnectionId string: ID of the physical dedicated line associated with the virtual interface.
directConnectGatewayId string: ID of the dedicated gateway associated with the virtual interface.
enableBfd boolean: Enable BFD detection. true: enabled false: disabled.
enableBfdEcho boolean: Enable BFD detection echo packet mode. true: enabled false: disabled.
enableNqa boolean: Is NQA detection enabled? true: enabled false: not enabled.
id string: Uniquely identifies the resource.
localIp string: Local gateway interconnection IP address of the virtual interface.
localIpv6Ip string: IPv6 address of the local gateway interconnection IP for the virtual interface.
nqaDetectInterval number: Interval for sending consecutive probe packets in NQA detection.
nqaDetectMultiplier number: NQA detection count. If the number of consecutive NQA detection failures reaches the set count, the link is considered faulty.
peerIp string: Peer gateway interconnection IP address of the virtual interface.
peerIpv6Ip string: IPv6 address of the peer gateway interconnection IP for the virtual interface.
routeType string: Route type of the virtual interface.
status string: Status of the virtual interface. Creating: creating Deleting: deleting Pending: configuring Available: available.
tags GetVirtualInterfaceTag[]: All tag information added to the virtual interface.
updateTime string: Time when the virtual interface was updated.
virtualInterfaceId string: ID of the virtual interface.
virtualInterfaceName string: Name of the virtual interface.
vlanId number: VLAN ID of the virtual interface.

account_id str: ID of the account to which the dedicated line gateway belongs.
bandwidth int: Bandwidth limit of the virtual interface, in Mbps.
bfd_detect_interval int: BFD detection interval (ms).
bfd_detect_multiplier int: BFD detection count.
creation_time str: Time when the virtual interface was created.
description str: Description of the virtual interface.
direct_connect_connection_id str: ID of the physical dedicated line associated with the virtual interface.
direct_connect_gateway_id str: ID of the dedicated gateway associated with the virtual interface.
enable_bfd bool: Enable BFD detection. true: enabled false: disabled.
enable_bfd_echo bool: Enable BFD detection echo packet mode. true: enabled false: disabled.
enable_nqa bool: Is NQA detection enabled? true: enabled false: not enabled.
id str: Uniquely identifies the resource.
local_ip str: Local gateway interconnection IP address of the virtual interface.
local_ipv6_ip str: IPv6 address of the local gateway interconnection IP for the virtual interface.
nqa_detect_interval int: Interval for sending consecutive probe packets in NQA detection.
nqa_detect_multiplier int: NQA detection count. If the number of consecutive NQA detection failures reaches the set count, the link is considered faulty.
peer_ip str: Peer gateway interconnection IP address of the virtual interface.
peer_ipv6_ip str: IPv6 address of the peer gateway interconnection IP for the virtual interface.
route_type str: Route type of the virtual interface.
status str: Status of the virtual interface. Creating: creating Deleting: deleting Pending: configuring Available: available.
tags Sequence[GetVirtualInterfaceTag]: All tag information added to the virtual interface.
update_time str: Time when the virtual interface was updated.
virtual_interface_id str: ID of the virtual interface.
virtual_interface_name str: Name of the virtual interface.
vlan_id int: VLAN ID of the virtual interface.

accountId String: ID of the account to which the dedicated line gateway belongs.
bandwidth Number: Bandwidth limit of the virtual interface, in Mbps.
bfdDetectInterval Number: BFD detection interval (ms).
bfdDetectMultiplier Number: BFD detection count.
creationTime String: Time when the virtual interface was created.
description String: Description of the virtual interface.
directConnectConnectionId String: ID of the physical dedicated line associated with the virtual interface.
directConnectGatewayId String: ID of the dedicated gateway associated with the virtual interface.
enableBfd Boolean: Enable BFD detection. true: enabled false: disabled.
enableBfdEcho Boolean: Enable BFD detection echo packet mode. true: enabled false: disabled.
enableNqa Boolean: Is NQA detection enabled? true: enabled false: not enabled.
id String: Uniquely identifies the resource.
localIp String: Local gateway interconnection IP address of the virtual interface.
localIpv6Ip String: IPv6 address of the local gateway interconnection IP for the virtual interface.
nqaDetectInterval Number: Interval for sending consecutive probe packets in NQA detection.
nqaDetectMultiplier Number: NQA detection count. If the number of consecutive NQA detection failures reaches the set count, the link is considered faulty.
peerIp String: Peer gateway interconnection IP address of the virtual interface.
peerIpv6Ip String: IPv6 address of the peer gateway interconnection IP for the virtual interface.
routeType String: Route type of the virtual interface.
status String: Status of the virtual interface. Creating: creating Deleting: deleting Pending: configuring Available: available.
tags List<Property Map>: All tag information added to the virtual interface.
updateTime String: Time when the virtual interface was updated.
virtualInterfaceId String: ID of the virtual interface.
virtualInterfaceName String: Name of the virtual interface.
vlanId Number: VLAN ID of the virtual interface.

Supporting Types

GetVirtualInterfaceTag

Key string: Tag key (Key) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag key (Key), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag keys (Key) are separated by &. Cannot start with sys: in any case. sys: is reserved for system tags and cannot be created. Length range: 1–128 characters. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@).
Value string: Tag value (Value) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag value (Value), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag values (Value) are separated by &. Length range: 0–256 characters. If not specified, the default is empty. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@). Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.

Key string: Tag key (Key) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag key (Key), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag keys (Key) are separated by &. Cannot start with sys: in any case. sys: is reserved for system tags and cannot be created. Length range: 1–128 characters. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@).
Value string: Tag value (Value) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag value (Value), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag values (Value) are separated by &. Length range: 0–256 characters. If not specified, the default is empty. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@). Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.

key string: Tag key (Key) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag key (Key), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag keys (Key) are separated by &. Cannot start with sys: in any case. sys: is reserved for system tags and cannot be created. Length range: 1–128 characters. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@).
value string: Tag value (Value) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag value (Value), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag values (Value) are separated by &. Length range: 0–256 characters. If not specified, the default is empty. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@). Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.

key String: Tag key (Key) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag key (Key), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag keys (Key) are separated by &. Cannot start with sys: in any case. sys: is reserved for system tags and cannot be created. Length range: 1–128 characters. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@).
value String: Tag value (Value) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag value (Value), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag values (Value) are separated by &. Length range: 0–256 characters. If not specified, the default is empty. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@). Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.

key string: Tag key (Key) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag key (Key), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag keys (Key) are separated by &. Cannot start with sys: in any case. sys: is reserved for system tags and cannot be created. Length range: 1–128 characters. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@).
value string: Tag value (Value) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag value (Value), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag values (Value) are separated by &. Length range: 0–256 characters. If not specified, the default is empty. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@). Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.

key str: Tag key (Key) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag key (Key), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag keys (Key) are separated by &. Cannot start with sys: in any case. sys: is reserved for system tags and cannot be created. Length range: 1–128 characters. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@).
value str: Tag value (Value) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag value (Value), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag values (Value) are separated by &. Length range: 0–256 characters. If not specified, the default is empty. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@). Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.

key String: Tag key (Key) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag key (Key), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag keys (Key) are separated by &. Cannot start with sys: in any case. sys: is reserved for system tags and cannot be created. Length range: 1–128 characters. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@).
value String: Tag value (Value) of the virtual interface tag. Parameter - N - indicates the sequence number of the tag value (Value), with a range of 1, 2, 3, …, 49, 50. N must be in continuous ascending order. Multiple tag values (Value) are separated by &. Length range: 0–256 characters. If not specified, the default is empty. Supports input in any language, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@). Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.31
published on Monday, Jun 1, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.directconnect.getVirtualInterface

On this page

On this page

Using getVirtualInterface

getVirtualInterface Result

Supporting Types

GetVirtualInterfaceTag

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

bytepluscc.directconnect.getVirtualInterface

On this page

On this page

Using getVirtualInterface

getVirtualInterface Result

Supporting Types

GetVirtualInterfaceTag

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.