1. Packages
  2. Volcengine
  3. API Docs
  4. direct_connect
  5. Gateways
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.direct_connect.Gateways

volcengine logo
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine
    Deprecated: volcengine.direct_connect.Gateways has been deprecated in favor of volcengine.direct_connect.getGateways

    Use this data source to query detailed information of direct connect gateways

    Example Usage

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

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

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.direct_connect.get_gateways(direct_connect_gateway_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.GetGateways(ctx, &direct_connect.GetGatewaysArgs{
			DirectConnectGatewayName: 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.GetGateways.Invoke(new()
    {
        DirectConnectGatewayName = "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.GetGatewaysArgs;
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.getGateways(GetGatewaysArgs.builder()
            .directConnectGatewayName("tf-test")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:direct_connect:getGateways
      Arguments:
        directConnectGatewayName: tf-test

    Using Gateways

    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 gateways(args: GatewaysArgs, opts?: InvokeOptions): Promise<GatewaysResult>
function gatewaysOutput(args: GatewaysOutputArgs, opts?: InvokeOptions): Output<GatewaysResult>
    def gateways(cen_id: Optional[str] = None,
             direct_connect_gateway_name: Optional[str] = None,
             ids: Optional[Sequence[str]] = None,
             name_regex: Optional[str] = None,
             output_file: Optional[str] = None,
             tag_filters: Optional[Sequence[GatewaysTagFilter]] = None,
             opts: Optional[InvokeOptions] = None) -> GatewaysResult
def gateways_output(cen_id: Optional[pulumi.Input[str]] = None,
             direct_connect_gateway_name: 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,
             tag_filters: Optional[pulumi.Input[Sequence[pulumi.Input[GatewaysTagFilterArgs]]]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GatewaysResult]
    func Gateways(ctx *Context, args *GatewaysArgs, opts ...InvokeOption) (*GatewaysResult, error)
func GatewaysOutput(ctx *Context, args *GatewaysOutputArgs, opts ...InvokeOption) GatewaysResultOutput
    public static class Gateways 
{
    public static Task<GatewaysResult> InvokeAsync(GatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GatewaysResult> Invoke(GatewaysInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GatewaysResult> gateways(GatewaysArgs args, InvokeOptions options)
public static Output<GatewaysResult> gateways(GatewaysArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:direct_connect:Gateways
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CenId string
    The CEN ID which direct connect gateway belongs.
    DirectConnectGatewayName string
    The direst connect gateway name.
    Ids List<string>
    A list of IDs.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    TagFilters List<GatewaysTagFilter>
    The filter tag of direct connect.
    CenId string
    The CEN ID which direct connect gateway belongs.
    DirectConnectGatewayName string
    The direst connect gateway name.
    Ids []string
    A list of IDs.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    TagFilters []GatewaysTagFilter
    The filter tag of direct connect.
    cenId String
    The CEN ID which direct connect gateway belongs.
    directConnectGatewayName String
    The direst connect gateway name.
    ids List<String>
    A list of IDs.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    tagFilters List<GatewaysTagFilter>
    The filter tag of direct connect.
    cenId string
    The CEN ID which direct connect gateway belongs.
    directConnectGatewayName string
    The direst connect gateway name.
    ids string[]
    A list of IDs.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    tagFilters GatewaysTagFilter[]
    The filter tag of direct connect.
    cen_id str
    The CEN ID which direct connect gateway belongs.
    direct_connect_gateway_name str
    The direst connect gateway name.
    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.
    tag_filters Sequence[GatewaysTagFilter]
    The filter tag of direct connect.
    cenId String
    The CEN ID which direct connect gateway belongs.
    directConnectGatewayName String
    The direst connect gateway name.
    ids List<String>
    A list of IDs.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    tagFilters List<Property Map>
    The filter tag of direct connect.

    Gateways Result

    The following output properties are available:

    DirectConnectGateways List<GatewaysDirectConnectGateway>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    CenId string
    The cen ID.
    DirectConnectGatewayName string
    The direct connect gateway name.
    Ids List<string>
    NameRegex string
    OutputFile string
    TagFilters List<GatewaysTagFilter>
    DirectConnectGateways []GatewaysDirectConnectGateway
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    CenId string
    The cen ID.
    DirectConnectGatewayName string
    The direct connect gateway name.
    Ids []string
    NameRegex string
    OutputFile string
    TagFilters []GatewaysTagFilter
    directConnectGateways List<GatewaysDirectConnectGateway>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    cenId String
    The cen ID.
    directConnectGatewayName String
    The direct connect gateway name.
    ids List<String>
    nameRegex String
    outputFile String
    tagFilters List<GatewaysTagFilter>
    directConnectGateways GatewaysDirectConnectGateway[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    cenId string
    The cen ID.
    directConnectGatewayName string
    The direct connect gateway name.
    ids string[]
    nameRegex string
    outputFile string
    tagFilters GatewaysTagFilter[]
    direct_connect_gateways Sequence[GatewaysDirectConnectGateway]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    cen_id str
    The cen ID.
    direct_connect_gateway_name str
    The direct connect gateway name.
    ids Sequence[str]
    name_regex str
    output_file str
    tag_filters Sequence[GatewaysTagFilter]
    directConnectGateways 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.
    cenId String
    The cen ID.
    directConnectGatewayName String
    The direct connect gateway name.
    ids List<String>
    nameRegex String
    outputFile String
    tagFilters List<Property Map>

    Supporting Types

    GatewaysDirectConnectGateway

    AccountId string
    The account ID that direct connect gateway belongs.
    AssociateCens List<GatewaysDirectConnectGatewayAssociateCen>
    The CEN information associated with the direct connect gateway.
    BusinessStatus string
    The business status of direct connect gateway.
    CreationTime string
    The creation time of direct connect gateway.
    DeletedTime string
    The expected resource force collection time. Only when the resource is frozen due to arrears, this parameter will have a return value, otherwise it will return a null value.
    Description string
    The description of direct connect gateway.
    DirectConnectGatewayId string
    The direct connect gateway ID.
    DirectConnectGatewayName string
    The direst connect gateway name.
    LockReason string
    The reason of the direct connect gateway locked.
    OverdueTime string
    The resource freeze time. Only when the resource is frozen due to arrears, this parameter will have a return value, otherwise it will return a null value.
    Status string
    The status of direct connect gateway.
    Tags List<GatewaysDirectConnectGatewayTag>
    The tags that direct connect gateway added.
    UpdateTime string
    The update time of direct connect gateway.
    AccountId string
    The account ID that direct connect gateway belongs.
    AssociateCens []GatewaysDirectConnectGatewayAssociateCen
    The CEN information associated with the direct connect gateway.
    BusinessStatus string
    The business status of direct connect gateway.
    CreationTime string
    The creation time of direct connect gateway.
    DeletedTime string
    The expected resource force collection time. Only when the resource is frozen due to arrears, this parameter will have a return value, otherwise it will return a null value.
    Description string
    The description of direct connect gateway.
    DirectConnectGatewayId string
    The direct connect gateway ID.
    DirectConnectGatewayName string
    The direst connect gateway name.
    LockReason string
    The reason of the direct connect gateway locked.
    OverdueTime string
    The resource freeze time. Only when the resource is frozen due to arrears, this parameter will have a return value, otherwise it will return a null value.
    Status string
    The status of direct connect gateway.
    Tags []GatewaysDirectConnectGatewayTag
    The tags that direct connect gateway added.
    UpdateTime string
    The update time of direct connect gateway.
    accountId String
    The account ID that direct connect gateway belongs.
    associateCens List<GatewaysDirectConnectGatewayAssociateCen>
    The CEN information associated with the direct connect gateway.
    businessStatus String
    The business status of direct connect gateway.
    creationTime String
    The creation time of direct connect gateway.
    deletedTime String
    The expected resource force collection time. Only when the resource is frozen due to arrears, this parameter will have a return value, otherwise it will return a null value.
    description String
    The description of direct connect gateway.
    directConnectGatewayId String
    The direct connect gateway ID.
    directConnectGatewayName String
    The direst connect gateway name.
    lockReason String
    The reason of the direct connect gateway locked.
    overdueTime String
    The resource freeze time. Only when the resource is frozen due to arrears, this parameter will have a return value, otherwise it will return a null value.
    status String
    The status of direct connect gateway.
    tags List<GatewaysDirectConnectGatewayTag>
    The tags that direct connect gateway added.
    updateTime String
    The update time of direct connect gateway.
    accountId string
    The account ID that direct connect gateway belongs.
    associateCens GatewaysDirectConnectGatewayAssociateCen[]
    The CEN information associated with the direct connect gateway.
    businessStatus string
    The business status of direct connect gateway.
    creationTime string
    The creation time of direct connect gateway.
    deletedTime string
    The expected resource force collection time. Only when the resource is frozen due to arrears, this parameter will have a return value, otherwise it will return a null value.
    description string
    The description of direct connect gateway.
    directConnectGatewayId string
    The direct connect gateway ID.
    directConnectGatewayName string
    The direst connect gateway name.
    lockReason string
    The reason of the direct connect gateway locked.
    overdueTime string
    The resource freeze time. Only when the resource is frozen due to arrears, this parameter will have a return value, otherwise it will return a null value.
    status string
    The status of direct connect gateway.
    tags GatewaysDirectConnectGatewayTag[]
    The tags that direct connect gateway added.
    updateTime string
    The update time of direct connect gateway.
    account_id str
    The account ID that direct connect gateway belongs.
    associate_cens Sequence[GatewaysDirectConnectGatewayAssociateCen]
    The CEN information associated with the direct connect gateway.
    business_status str
    The business status of direct connect gateway.
    creation_time str
    The creation time of direct connect gateway.
    deleted_time str
    The expected resource force collection time. Only when the resource is frozen due to arrears, this parameter will have a return value, otherwise it will return a null value.
    description str
    The description of direct connect gateway.
    direct_connect_gateway_id str
    The direct connect gateway ID.
    direct_connect_gateway_name str
    The direst connect gateway name.
    lock_reason str
    The reason of the direct connect gateway locked.
    overdue_time str
    The resource freeze time. Only when the resource is frozen due to arrears, this parameter will have a return value, otherwise it will return a null value.
    status str
    The status of direct connect gateway.
    tags Sequence[GatewaysDirectConnectGatewayTag]
    The tags that direct connect gateway added.
    update_time str
    The update time of direct connect gateway.
    accountId String
    The account ID that direct connect gateway belongs.
    associateCens List<Property Map>
    The CEN information associated with the direct connect gateway.
    businessStatus String
    The business status of direct connect gateway.
    creationTime String
    The creation time of direct connect gateway.
    deletedTime String
    The expected resource force collection time. Only when the resource is frozen due to arrears, this parameter will have a return value, otherwise it will return a null value.
    description String
    The description of direct connect gateway.
    directConnectGatewayId String
    The direct connect gateway ID.
    directConnectGatewayName String
    The direst connect gateway name.
    lockReason String
    The reason of the direct connect gateway locked.
    overdueTime String
    The resource freeze time. Only when the resource is frozen due to arrears, this parameter will have a return value, otherwise it will return a null value.
    status String
    The status of direct connect gateway.
    tags List<Property Map>
    The tags that direct connect gateway added.
    updateTime String
    The update time of direct connect gateway.

    GatewaysDirectConnectGatewayAssociateCen

    CenId string
    The CEN ID which direct connect gateway belongs.
    CenOwnerId string
    The CEN owner's ID.
    CenStatus string
    The CEN status.
    CenId string
    The CEN ID which direct connect gateway belongs.
    CenOwnerId string
    The CEN owner's ID.
    CenStatus string
    The CEN status.
    cenId String
    The CEN ID which direct connect gateway belongs.
    cenOwnerId String
    The CEN owner's ID.
    cenStatus String
    The CEN status.
    cenId string
    The CEN ID which direct connect gateway belongs.
    cenOwnerId string
    The CEN owner's ID.
    cenStatus string
    The CEN status.
    cen_id str
    The CEN ID which direct connect gateway belongs.
    cen_owner_id str
    The CEN owner's ID.
    cen_status str
    The CEN status.
    cenId String
    The CEN ID which direct connect gateway belongs.
    cenOwnerId String
    The CEN owner's ID.
    cenStatus String
    The CEN status.

    GatewaysDirectConnectGatewayTag

    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.

    GatewaysTagFilter

    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.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Viewing docs for Volcengine v0.0.47
    published on Friday, Mar 13, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Try Pulumi Cloud free. Your team will thank you.