volcenginecc.directconnect.getDirectConnectGateway

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getDirectConnectGateway

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 getDirectConnectGateway(args: GetDirectConnectGatewayArgs, opts?: InvokeOptions): Promise<GetDirectConnectGatewayResult>
function getDirectConnectGatewayOutput(args: GetDirectConnectGatewayOutputArgs, opts?: InvokeOptions): Output<GetDirectConnectGatewayResult>

def get_direct_connect_gateway(id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetDirectConnectGatewayResult
def get_direct_connect_gateway_output(id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetDirectConnectGatewayResult]

func LookupDirectConnectGateway(ctx *Context, args *LookupDirectConnectGatewayArgs, opts ...InvokeOption) (*LookupDirectConnectGatewayResult, error)
func LookupDirectConnectGatewayOutput(ctx *Context, args *LookupDirectConnectGatewayOutputArgs, opts ...InvokeOption) LookupDirectConnectGatewayResultOutput

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

public static class GetDirectConnectGateway 
{
    public static Task<GetDirectConnectGatewayResult> InvokeAsync(GetDirectConnectGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetDirectConnectGatewayResult> Invoke(GetDirectConnectGatewayInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDirectConnectGatewayResult> getDirectConnectGateway(GetDirectConnectGatewayArgs args, InvokeOptions options)
public static Output<GetDirectConnectGatewayResult> getDirectConnectGateway(GetDirectConnectGatewayArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:directconnect/getDirectConnectGateway:getDirectConnectGateway
  arguments:
    # arguments dictionary

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 str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getDirectConnectGateway Result

The following output properties are available:

AccountId string: ID of the account to which the Direct Connect Gateway belongs.
AssociateCens List<Volcengine.GetDirectConnectGatewayAssociateCen>: Associated CEN information.
AssociateEic Volcengine.GetDirectConnectGatewayAssociateEic: Associated EIC information.
BgpAsn int: ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
BusinessStatus string: Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
CreatedTime string: Time when the Direct Connect Gateway was created.
DeletedTime string: Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
Description string: Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
DirectConnectGatewayId string: ID of the Direct Connect Gateway.
DirectConnectGatewayName string: Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
EnableIpv6 bool: Whether IPv6 is supported. true: supported. false: not supported.
Id string: Uniquely identifies the resource.
LockReason string: Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
OverdueTime string: Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
ProjectName string: Project to which the Direct Connect Gateway belongs.
Status string: Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
Tags List<Volcengine.GetDirectConnectGatewayTag>: All tag information added to the Direct Connect Gateway.
UpdatedTime string: Time when the Direct Connect Gateway was updated.

AccountId string: ID of the account to which the Direct Connect Gateway belongs.
AssociateCens []GetDirectConnectGatewayAssociateCen: Associated CEN information.
AssociateEic GetDirectConnectGatewayAssociateEic: Associated EIC information.
BgpAsn int: ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
BusinessStatus string: Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
CreatedTime string: Time when the Direct Connect Gateway was created.
DeletedTime string: Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
Description string: Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
DirectConnectGatewayId string: ID of the Direct Connect Gateway.
DirectConnectGatewayName string: Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
EnableIpv6 bool: Whether IPv6 is supported. true: supported. false: not supported.
Id string: Uniquely identifies the resource.
LockReason string: Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
OverdueTime string: Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
ProjectName string: Project to which the Direct Connect Gateway belongs.
Status string: Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
Tags []GetDirectConnectGatewayTag: All tag information added to the Direct Connect Gateway.
UpdatedTime string: Time when the Direct Connect Gateway was updated.

accountId String: ID of the account to which the Direct Connect Gateway belongs.
associateCens List<GetDirectConnectGatewayAssociateCen>: Associated CEN information.
associateEic GetDirectConnectGatewayAssociateEic: Associated EIC information.
bgpAsn Integer: ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
businessStatus String: Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
createdTime String: Time when the Direct Connect Gateway was created.
deletedTime String: Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
description String: Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
directConnectGatewayId String: ID of the Direct Connect Gateway.
directConnectGatewayName String: Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
enableIpv6 Boolean: Whether IPv6 is supported. true: supported. false: not supported.
id String: Uniquely identifies the resource.
lockReason String: Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
overdueTime String: Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
projectName String: Project to which the Direct Connect Gateway belongs.
status String: Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
tags List<GetDirectConnectGatewayTag>: All tag information added to the Direct Connect Gateway.
updatedTime String: Time when the Direct Connect Gateway was updated.

accountId string: ID of the account to which the Direct Connect Gateway belongs.
associateCens GetDirectConnectGatewayAssociateCen[]: Associated CEN information.
associateEic GetDirectConnectGatewayAssociateEic: Associated EIC information.
bgpAsn number: ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
businessStatus string: Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
createdTime string: Time when the Direct Connect Gateway was created.
deletedTime string: Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
description string: Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
directConnectGatewayId string: ID of the Direct Connect Gateway.
directConnectGatewayName string: Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
enableIpv6 boolean: Whether IPv6 is supported. true: supported. false: not supported.
id string: Uniquely identifies the resource.
lockReason string: Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
overdueTime string: Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
projectName string: Project to which the Direct Connect Gateway belongs.
status string: Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
tags GetDirectConnectGatewayTag[]: All tag information added to the Direct Connect Gateway.
updatedTime string: Time when the Direct Connect Gateway was updated.

account_id str: ID of the account to which the Direct Connect Gateway belongs.
associate_cens Sequence[GetDirectConnectGatewayAssociateCen]: Associated CEN information.
associate_eic GetDirectConnectGatewayAssociateEic: Associated EIC information.
bgp_asn int: ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
business_status str: Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
created_time str: Time when the Direct Connect Gateway was created.
deleted_time str: Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
description str: Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
direct_connect_gateway_id str: ID of the Direct Connect Gateway.
direct_connect_gateway_name str: Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
enable_ipv6 bool: Whether IPv6 is supported. true: supported. false: not supported.
id str: Uniquely identifies the resource.
lock_reason str: Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
overdue_time str: Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
project_name str: Project to which the Direct Connect Gateway belongs.
status str: Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
tags Sequence[GetDirectConnectGatewayTag]: All tag information added to the Direct Connect Gateway.
updated_time str: Time when the Direct Connect Gateway was updated.

accountId String: ID of the account to which the Direct Connect Gateway belongs.
associateCens List<Property Map>: Associated CEN information.
associateEic Property Map: Associated EIC information.
bgpAsn Number: ASN (Autonomous System Number) of the Direct Connect Gateway. Valid ASN range: 137718, 64512–65534, 4200000000–4294967294, where 137718 is the ASN for Volcengine. If the Direct Connect Gateway is used in standard scenarios (such as a local IDC connecting to a single cloud VPC resource via dedicated connection), use the Volcengine ASN (137718). If used in special scenarios (such as a single IDC connecting to multiple Cloud Enterprise Networks via dedicated connection), each Direct Connect Gateway must use a custom ASN and avoid using the Volcengine ASN (137718), ensuring that ASNs are not duplicated across Direct Connect Gateways.
businessStatus String: Indicates whether the dedicated gateway is locked. Normal: normal. FinancialLocked: locked.
createdTime String: Time when the Direct Connect Gateway was created.
deletedTime String: Expected forced resource reclamation time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
description String: Description for the dedicated gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length is limited to 0 to 255 characters. If this parameter is not provided or no value is entered, the default is an empty string.
directConnectGatewayId String: ID of the Direct Connect Gateway.
directConnectGatewayName String: Name of the Direct Connect Gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. If this parameter is not provided or no value is specified, the default is the Direct Connect Gateway ID.
enableIpv6 Boolean: Whether IPv6 is supported. true: supported. false: not supported.
id String: Uniquely identifies the resource.
lockReason String: Reason for Direct Connect Gateway lock. unlock: not locked; financial: locked due to overdue payment; security: locked due to security reasons.
overdueTime String: Resource freeze time. This parameter returns a value only if the resource is frozen due to overdue payment; otherwise, it returns null.
projectName String: Project to which the Direct Connect Gateway belongs.
status String: Status of the Direct Connect Gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available.
tags List<Property Map>: All tag information added to the Direct Connect Gateway.
updatedTime String: Time when the Direct Connect Gateway was updated.

Supporting Types

GetDirectConnectGatewayAssociateCen

CenId string: ID of CEN.
CenOwnerId string: User ID of CEN.
CenStatus string: Status of the instance in CEN. Attaching: attaching. Attached: attached.

CenId string: ID of CEN.
CenOwnerId string: User ID of CEN.
CenStatus string: Status of the instance in CEN. Attaching: attaching. Attached: attached.

cenId String: ID of CEN.
cenOwnerId String: User ID of CEN.
cenStatus String: Status of the instance in CEN. Attaching: attaching. Attached: attached.

cenId string: ID of CEN.
cenOwnerId string: User ID of CEN.
cenStatus string: Status of the instance in CEN. Attaching: attaching. Attached: attached.

cen_id str: ID of CEN.
cen_owner_id str: User ID of CEN.
cen_status str: Status of the instance in CEN. Attaching: attaching. Attached: attached.

cenId String: ID of CEN.
cenOwnerId String: User ID of CEN.
cenStatus String: Status of the instance in CEN. Attaching: attaching. Attached: attached.

GetDirectConnectGatewayAssociateEic

EicId string: ID of EIC.
EicOwnerId string: User ID of EIC.
EicStatus string: Status of the instance in EIC.

EicId string: ID of EIC.
EicOwnerId string: User ID of EIC.
EicStatus string: Status of the instance in EIC.

eicId String: ID of EIC.
eicOwnerId String: User ID of EIC.
eicStatus String: Status of the instance in EIC.

eicId string: ID of EIC.
eicOwnerId string: User ID of EIC.
eicStatus string: Status of the instance in EIC.

eic_id str: ID of EIC.
eic_owner_id str: User ID of EIC.
eic_status str: Status of the instance in EIC.

eicId String: ID of EIC.
eicOwnerId String: User ID of EIC.
eicStatus String: Status of the instance in EIC.

GetDirectConnectGatewayTag

Key string: User label tag key. Length must be between 1 and 128 characters.
Value string: User label tag value. Length must be between 0 and 256 characters.

Key string: User label tag key. Length must be between 1 and 128 characters.
Value string: User label tag value. Length must be between 0 and 256 characters.

key String: User label tag key. Length must be between 1 and 128 characters.
value String: User label tag value. Length must be between 0 and 256 characters.

key string: User label tag key. Length must be between 1 and 128 characters.
value string: User label tag value. Length must be between 0 and 256 characters.

key str: User label tag key. Length must be between 1 and 128 characters.
value str: User label tag value. Length must be between 0 and 256 characters.

key String: User label tag key. Length must be between 1 and 128 characters.
value String: User label tag value. Length must be between 0 and 256 characters.