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

volcengine.direct_connect.getGatewayRoutes

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 gateway routes

    Example Usage

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

const foo = volcengine.direct_connect.getGatewayRoutes({
    ids: [
        "dcr-638ry33wmzggn3gd6gv****",
        "dcr-20d6tkadi2k8w65sqhgbj****",
    ],
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.direct_connect.get_gateway_routes(ids=[
    "dcr-638ry33wmzggn3gd6gv****",
    "dcr-20d6tkadi2k8w65sqhgbj****",
])

    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.GetGatewayRoutes(ctx, &direct_connect.GetGatewayRoutesArgs{
			Ids: []string{
				"dcr-638ry33wmzggn3gd6gv****",
				"dcr-20d6tkadi2k8w65sqhgbj****",
			},
		}, 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.GetGatewayRoutes.Invoke(new()
    {
        Ids = new[]
        {
            "dcr-638ry33wmzggn3gd6gv****",
            "dcr-20d6tkadi2k8w65sqhgbj****",
        },
    });

});

    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.GetGatewayRoutesArgs;
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.getGatewayRoutes(GetGatewayRoutesArgs.builder()
            .ids(            
                "dcr-638ry33wmzggn3gd6gv****",
                "dcr-20d6tkadi2k8w65sqhgbj****")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:direct_connect:getGatewayRoutes
      Arguments:
        ids:
          - dcr-638ry33wmzggn3gd6gv****
          - dcr-20d6tkadi2k8w65sqhgbj****

    Using getGatewayRoutes

    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 getGatewayRoutes(args: GetGatewayRoutesArgs, opts?: InvokeOptions): Promise<GetGatewayRoutesResult>
function getGatewayRoutesOutput(args: GetGatewayRoutesOutputArgs, opts?: InvokeOptions): Output<GetGatewayRoutesResult>
    def get_gateway_routes(destination_cidr_block: Optional[str] = None,
                       direct_connect_gateway_id: Optional[str] = None,
                       ids: Optional[Sequence[str]] = None,
                       next_hop_id: Optional[str] = None,
                       next_hop_type: Optional[str] = None,
                       output_file: Optional[str] = None,
                       route_type: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetGatewayRoutesResult
def get_gateway_routes_output(destination_cidr_block: Optional[pulumi.Input[str]] = None,
                       direct_connect_gateway_id: Optional[pulumi.Input[str]] = None,
                       ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       next_hop_id: Optional[pulumi.Input[str]] = None,
                       next_hop_type: Optional[pulumi.Input[str]] = None,
                       output_file: Optional[pulumi.Input[str]] = None,
                       route_type: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetGatewayRoutesResult]
    func GetGatewayRoutes(ctx *Context, args *GetGatewayRoutesArgs, opts ...InvokeOption) (*GetGatewayRoutesResult, error)
func GetGatewayRoutesOutput(ctx *Context, args *GetGatewayRoutesOutputArgs, opts ...InvokeOption) GetGatewayRoutesResultOutput

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

    public static class GetGatewayRoutes 
{
    public static Task<GetGatewayRoutesResult> InvokeAsync(GetGatewayRoutesArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayRoutesResult> Invoke(GetGatewayRoutesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayRoutesResult> getGatewayRoutes(GetGatewayRoutesArgs args, InvokeOptions options)
public static Output<GetGatewayRoutesResult> getGatewayRoutes(GetGatewayRoutesArgs args, InvokeOptions options)

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

    The following arguments are supported:

    DestinationCidrBlock string
    The cidr block.
    DirectConnectGatewayId string
    The id of direct connect gateway.
    Ids List<string>
    A list of IDs.
    NextHopId string
    The id of next hop.
    NextHopType string
    The type of next hop.
    OutputFile string
    File name where to save data source results.
    RouteType string
    The type of route. The value can be BGP or CEN or Static.
    DestinationCidrBlock string
    The cidr block.
    DirectConnectGatewayId string
    The id of direct connect gateway.
    Ids []string
    A list of IDs.
    NextHopId string
    The id of next hop.
    NextHopType string
    The type of next hop.
    OutputFile string
    File name where to save data source results.
    RouteType string
    The type of route. The value can be BGP or CEN or Static.
    destinationCidrBlock String
    The cidr block.
    directConnectGatewayId String
    The id of direct connect gateway.
    ids List<String>
    A list of IDs.
    nextHopId String
    The id of next hop.
    nextHopType String
    The type of next hop.
    outputFile String
    File name where to save data source results.
    routeType String
    The type of route. The value can be BGP or CEN or Static.
    destinationCidrBlock string
    The cidr block.
    directConnectGatewayId string
    The id of direct connect gateway.
    ids string[]
    A list of IDs.
    nextHopId string
    The id of next hop.
    nextHopType string
    The type of next hop.
    outputFile string
    File name where to save data source results.
    routeType string
    The type of route. The value can be BGP or CEN or Static.
    destination_cidr_block str
    The cidr block.
    direct_connect_gateway_id str
    The id of direct connect gateway.
    ids Sequence[str]
    A list of IDs.
    next_hop_id str
    The id of next hop.
    next_hop_type str
    The type of next hop.
    output_file str
    File name where to save data source results.
    route_type str
    The type of route. The value can be BGP or CEN or Static.
    destinationCidrBlock String
    The cidr block.
    directConnectGatewayId String
    The id of direct connect gateway.
    ids List<String>
    A list of IDs.
    nextHopId String
    The id of next hop.
    nextHopType String
    The type of next hop.
    outputFile String
    File name where to save data source results.
    routeType String
    The type of route. The value can be BGP or CEN or Static.

    getGatewayRoutes Result

    The following output properties are available:

    DirectConnectGatewayRoutes List<GetGatewayRoutesDirectConnectGatewayRoute>
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    DestinationCidrBlock string
    The cidr block.
    DirectConnectGatewayId string
    The id of direct connect gateway.
    Ids List<string>
    NextHopId string
    The id of next hop.
    NextHopType string
    The type of next hop.
    OutputFile string
    RouteType string
    The type of route.
    DirectConnectGatewayRoutes []GetGatewayRoutesDirectConnectGatewayRoute
    The collection of query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    DestinationCidrBlock string
    The cidr block.
    DirectConnectGatewayId string
    The id of direct connect gateway.
    Ids []string
    NextHopId string
    The id of next hop.
    NextHopType string
    The type of next hop.
    OutputFile string
    RouteType string
    The type of route.
    directConnectGatewayRoutes List<GetGatewayRoutesDirectConnectGatewayRoute>
    The collection of query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    destinationCidrBlock String
    The cidr block.
    directConnectGatewayId String
    The id of direct connect gateway.
    ids List<String>
    nextHopId String
    The id of next hop.
    nextHopType String
    The type of next hop.
    outputFile String
    routeType String
    The type of route.
    directConnectGatewayRoutes GetGatewayRoutesDirectConnectGatewayRoute[]
    The collection of query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    destinationCidrBlock string
    The cidr block.
    directConnectGatewayId string
    The id of direct connect gateway.
    ids string[]
    nextHopId string
    The id of next hop.
    nextHopType string
    The type of next hop.
    outputFile string
    routeType string
    The type of route.
    direct_connect_gateway_routes Sequence[GetGatewayRoutesDirectConnectGatewayRoute]
    The collection of query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    destination_cidr_block str
    The cidr block.
    direct_connect_gateway_id str
    The id of direct connect gateway.
    ids Sequence[str]
    next_hop_id str
    The id of next hop.
    next_hop_type str
    The type of next hop.
    output_file str
    route_type str
    The type of route.
    directConnectGatewayRoutes 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.
    destinationCidrBlock String
    The cidr block.
    directConnectGatewayId String
    The id of direct connect gateway.
    ids List<String>
    nextHopId String
    The id of next hop.
    nextHopType String
    The type of next hop.
    outputFile String
    routeType String
    The type of route.

    Supporting Types

    GetGatewayRoutesDirectConnectGatewayRoute

    AccountId string
    The id of account.
    CreationTime string
    The create time.
    DestinationCidrBlock string
    The cidr block.
    DirectConnectGatewayId string
    The id of direct connect gateway.
    DirectConnectGatewayRouteId string
    The id of direct connect gateway route.
    NextHopId string
    The id of next hop.
    NextHopType string
    The type of next hop.
    RouteType string
    The type of route. The value can be BGP or CEN or Static.
    Status string
    The status info.
    AccountId string
    The id of account.
    CreationTime string
    The create time.
    DestinationCidrBlock string
    The cidr block.
    DirectConnectGatewayId string
    The id of direct connect gateway.
    DirectConnectGatewayRouteId string
    The id of direct connect gateway route.
    NextHopId string
    The id of next hop.
    NextHopType string
    The type of next hop.
    RouteType string
    The type of route. The value can be BGP or CEN or Static.
    Status string
    The status info.
    accountId String
    The id of account.
    creationTime String
    The create time.
    destinationCidrBlock String
    The cidr block.
    directConnectGatewayId String
    The id of direct connect gateway.
    directConnectGatewayRouteId String
    The id of direct connect gateway route.
    nextHopId String
    The id of next hop.
    nextHopType String
    The type of next hop.
    routeType String
    The type of route. The value can be BGP or CEN or Static.
    status String
    The status info.
    accountId string
    The id of account.
    creationTime string
    The create time.
    destinationCidrBlock string
    The cidr block.
    directConnectGatewayId string
    The id of direct connect gateway.
    directConnectGatewayRouteId string
    The id of direct connect gateway route.
    nextHopId string
    The id of next hop.
    nextHopType string
    The type of next hop.
    routeType string
    The type of route. The value can be BGP or CEN or Static.
    status string
    The status info.
    account_id str
    The id of account.
    creation_time str
    The create time.
    destination_cidr_block str
    The cidr block.
    direct_connect_gateway_id str
    The id of direct connect gateway.
    direct_connect_gateway_route_id str
    The id of direct connect gateway route.
    next_hop_id str
    The id of next hop.
    next_hop_type str
    The type of next hop.
    route_type str
    The type of route. The value can be BGP or CEN or Static.
    status str
    The status info.
    accountId String
    The id of account.
    creationTime String
    The create time.
    destinationCidrBlock String
    The cidr block.
    directConnectGatewayId String
    The id of direct connect gateway.
    directConnectGatewayRouteId String
    The id of direct connect gateway route.
    nextHopId String
    The id of next hop.
    nextHopType String
    The type of next hop.
    routeType String
    The type of route. The value can be BGP or CEN or Static.
    status String
    The status info.

    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