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

volcengine.transit_router.getTransitRouters

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 transit routers

    Example Usage

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

const foo = new volcengine.transit_router.TransitRouter("foo", {
    transitRouterName: "test-tf-acc",
    description: "test-tf-acc",
});
const default = volcengine.transit_router.getTransitRoutersOutput({
    ids: [foo.id],
    transitRouterName: "test",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.transit_router.TransitRouter("foo",
    transit_router_name="test-tf-acc",
    description="test-tf-acc")
default = volcengine.transit_router.get_transit_routers_output(ids=[foo.id],
    transit_router_name="test")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/transit_router"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		foo, err := transit_router.NewTransitRouter(ctx, "foo", &transit_router.TransitRouterArgs{
			TransitRouterName: pulumi.String("test-tf-acc"),
			Description:       pulumi.String("test-tf-acc"),
		})
		if err != nil {
			return err
		}
		_ = transit_router.GetTransitRoutersOutput(ctx, transit_router.GetTransitRoutersOutputArgs{
			Ids: pulumi.StringArray{
				foo.ID(),
			},
			TransitRouterName: pulumi.String("test"),
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Transit_router.TransitRouter("foo", new()
    {
        TransitRouterName = "test-tf-acc",
        Description = "test-tf-acc",
    });

    var @default = Volcengine.Transit_router.GetTransitRouters.Invoke(new()
    {
        Ids = new[]
        {
            foo.Id,
        },
        TransitRouterName = "test",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.transit_router.TransitRouter;
import com.pulumi.volcengine.transit_router.TransitRouterArgs;
import com.pulumi.volcengine.transit_router.Transit_routerFunctions;
import com.pulumi.volcengine.transit_router.inputs.GetTransitRoutersArgs;
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) {
        var foo = new TransitRouter("foo", TransitRouterArgs.builder()        
            .transitRouterName("test-tf-acc")
            .description("test-tf-acc")
            .build());

        final var default = Transit_routerFunctions.getTransitRouters(GetTransitRoutersArgs.builder()
            .ids(foo.id())
            .transitRouterName("test")
            .build());

    }
}

    resources:
  foo:
    type: volcengine:transit_router:TransitRouter
    properties:
      transitRouterName: test-tf-acc
      description: test-tf-acc
variables:
  default:
    fn::invoke:
      Function: volcengine:transit_router:getTransitRouters
      Arguments:
        ids:
          - ${foo.id}
        transitRouterName: test

    Using getTransitRouters

    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 getTransitRouters(args: GetTransitRoutersArgs, opts?: InvokeOptions): Promise<GetTransitRoutersResult>
function getTransitRoutersOutput(args: GetTransitRoutersOutputArgs, opts?: InvokeOptions): Output<GetTransitRoutersResult>
    def get_transit_routers(ids: Optional[Sequence[str]] = None,
                        output_file: Optional[str] = None,
                        project_name: Optional[str] = None,
                        tags: Optional[Sequence[GetTransitRoutersTag]] = None,
                        transit_router_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetTransitRoutersResult
def get_transit_routers_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        output_file: Optional[pulumi.Input[str]] = None,
                        project_name: Optional[pulumi.Input[str]] = None,
                        tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetTransitRoutersTagArgs]]]] = None,
                        transit_router_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetTransitRoutersResult]
    func GetTransitRouters(ctx *Context, args *GetTransitRoutersArgs, opts ...InvokeOption) (*GetTransitRoutersResult, error)
func GetTransitRoutersOutput(ctx *Context, args *GetTransitRoutersOutputArgs, opts ...InvokeOption) GetTransitRoutersResultOutput

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

    public static class GetTransitRouters 
{
    public static Task<GetTransitRoutersResult> InvokeAsync(GetTransitRoutersArgs args, InvokeOptions? opts = null)
    public static Output<GetTransitRoutersResult> Invoke(GetTransitRoutersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTransitRoutersResult> getTransitRouters(GetTransitRoutersArgs args, InvokeOptions options)
public static Output<GetTransitRoutersResult> getTransitRouters(GetTransitRoutersArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:transit_router/getTransitRouters:getTransitRouters
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of Transit Router ids.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The ProjectName of the transit router.
    Tags List<GetTransitRoutersTag>
    Tags.
    TransitRouterName string
    The name info.
    Ids []string
    A list of Transit Router ids.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The ProjectName of the transit router.
    Tags []GetTransitRoutersTag
    Tags.
    TransitRouterName string
    The name info.
    ids List<String>
    A list of Transit Router ids.
    outputFile String
    File name where to save data source results.
    projectName String
    The ProjectName of the transit router.
    tags List<GetTransitRoutersTag>
    Tags.
    transitRouterName String
    The name info.
    ids string[]
    A list of Transit Router ids.
    outputFile string
    File name where to save data source results.
    projectName string
    The ProjectName of the transit router.
    tags GetTransitRoutersTag[]
    Tags.
    transitRouterName string
    The name info.
    ids Sequence[str]
    A list of Transit Router ids.
    output_file str
    File name where to save data source results.
    project_name str
    The ProjectName of the transit router.
    tags Sequence[GetTransitRoutersTag]
    Tags.
    transit_router_name str
    The name info.
    ids List<String>
    A list of Transit Router ids.
    outputFile String
    File name where to save data source results.
    projectName String
    The ProjectName of the transit router.
    tags List<Property Map>
    Tags.
    transitRouterName String
    The name info.

    getTransitRouters 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.
    TransitRouters List<GetTransitRoutersTransitRouter>
    The collection of query.
    Ids List<string>
    OutputFile string
    ProjectName string
    The ProjectName of the transit router.
    Tags List<GetTransitRoutersTag>
    Tags.
    TransitRouterName string
    The name of the transit router.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    TransitRouters []GetTransitRoutersTransitRouter
    The collection of query.
    Ids []string
    OutputFile string
    ProjectName string
    The ProjectName of the transit router.
    Tags []GetTransitRoutersTag
    Tags.
    TransitRouterName string
    The name of the transit router.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    transitRouters List<GetTransitRoutersTransitRouter>
    The collection of query.
    ids List<String>
    outputFile String
    projectName String
    The ProjectName of the transit router.
    tags List<GetTransitRoutersTag>
    Tags.
    transitRouterName String
    The name of the transit router.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    transitRouters GetTransitRoutersTransitRouter[]
    The collection of query.
    ids string[]
    outputFile string
    projectName string
    The ProjectName of the transit router.
    tags GetTransitRoutersTag[]
    Tags.
    transitRouterName string
    The name of the transit router.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    transit_routers Sequence[GetTransitRoutersTransitRouter]
    The collection of query.
    ids Sequence[str]
    output_file str
    project_name str
    The ProjectName of the transit router.
    tags Sequence[GetTransitRoutersTag]
    Tags.
    transit_router_name str
    The name of the transit router.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    transitRouters List<Property Map>
    The collection of query.
    ids List<String>
    outputFile String
    projectName String
    The ProjectName of the transit router.
    tags List<Property Map>
    Tags.
    transitRouterName String
    The name of the transit router.

    Supporting Types

    GetTransitRoutersTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    GetTransitRoutersTransitRouter

    AccountId string
    The ID of account.
    Asn int
    The asn of the transit router.
    BusinessStatus string
    The business status of the transit router.
    CreationTime string
    The create time.
    Description string
    The description info.
    GrantStatus string
    The grant status of the transit router.
    Id string
    The ID of the transit router.
    OverdueTime string
    The overdue time.
    ProjectName string
    The ProjectName of the transit router.
    Status string
    The status of the transit router.
    Tags List<GetTransitRoutersTransitRouterTag>
    Tags.
    TransitRouterAttachments List<GetTransitRoutersTransitRouterTransitRouterAttachment>
    The attachments of transit router.
    TransitRouterId string
    The ID of the transit router.
    TransitRouterName string
    The name info.
    UpdateTime string
    The update time.
    AccountId string
    The ID of account.
    Asn int
    The asn of the transit router.
    BusinessStatus string
    The business status of the transit router.
    CreationTime string
    The create time.
    Description string
    The description info.
    GrantStatus string
    The grant status of the transit router.
    Id string
    The ID of the transit router.
    OverdueTime string
    The overdue time.
    ProjectName string
    The ProjectName of the transit router.
    Status string
    The status of the transit router.
    Tags []GetTransitRoutersTransitRouterTag
    Tags.
    TransitRouterAttachments []GetTransitRoutersTransitRouterTransitRouterAttachment
    The attachments of transit router.
    TransitRouterId string
    The ID of the transit router.
    TransitRouterName string
    The name info.
    UpdateTime string
    The update time.
    accountId String
    The ID of account.
    asn Integer
    The asn of the transit router.
    businessStatus String
    The business status of the transit router.
    creationTime String
    The create time.
    description String
    The description info.
    grantStatus String
    The grant status of the transit router.
    id String
    The ID of the transit router.
    overdueTime String
    The overdue time.
    projectName String
    The ProjectName of the transit router.
    status String
    The status of the transit router.
    tags List<GetTransitRoutersTransitRouterTag>
    Tags.
    transitRouterAttachments List<GetTransitRoutersTransitRouterTransitRouterAttachment>
    The attachments of transit router.
    transitRouterId String
    The ID of the transit router.
    transitRouterName String
    The name info.
    updateTime String
    The update time.
    accountId string
    The ID of account.
    asn number
    The asn of the transit router.
    businessStatus string
    The business status of the transit router.
    creationTime string
    The create time.
    description string
    The description info.
    grantStatus string
    The grant status of the transit router.
    id string
    The ID of the transit router.
    overdueTime string
    The overdue time.
    projectName string
    The ProjectName of the transit router.
    status string
    The status of the transit router.
    tags GetTransitRoutersTransitRouterTag[]
    Tags.
    transitRouterAttachments GetTransitRoutersTransitRouterTransitRouterAttachment[]
    The attachments of transit router.
    transitRouterId string
    The ID of the transit router.
    transitRouterName string
    The name info.
    updateTime string
    The update time.
    account_id str
    The ID of account.
    asn int
    The asn of the transit router.
    business_status str
    The business status of the transit router.
    creation_time str
    The create time.
    description str
    The description info.
    grant_status str
    The grant status of the transit router.
    id str
    The ID of the transit router.
    overdue_time str
    The overdue time.
    project_name str
    The ProjectName of the transit router.
    status str
    The status of the transit router.
    tags Sequence[GetTransitRoutersTransitRouterTag]
    Tags.
    transit_router_attachments Sequence[GetTransitRoutersTransitRouterTransitRouterAttachment]
    The attachments of transit router.
    transit_router_id str
    The ID of the transit router.
    transit_router_name str
    The name info.
    update_time str
    The update time.
    accountId String
    The ID of account.
    asn Number
    The asn of the transit router.
    businessStatus String
    The business status of the transit router.
    creationTime String
    The create time.
    description String
    The description info.
    grantStatus String
    The grant status of the transit router.
    id String
    The ID of the transit router.
    overdueTime String
    The overdue time.
    projectName String
    The ProjectName of the transit router.
    status String
    The status of the transit router.
    tags List<Property Map>
    Tags.
    transitRouterAttachments List<Property Map>
    The attachments of transit router.
    transitRouterId String
    The ID of the transit router.
    transitRouterName String
    The name info.
    updateTime String
    The update time.

    GetTransitRoutersTransitRouterTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    GetTransitRoutersTransitRouterTransitRouterAttachment

    CreationTime string
    The create time.
    ResourceId string
    The id of resource.
    ResourceType string
    The type of resource.
    Status string
    The status of the transit router.
    TransitRouterAttachmentId string
    The id of transit router attachment.
    TransitRouterAttachmentName string
    The name of transit router attachment.
    TransitRouterRouteTableId string
    The id of transit router route table.
    UpdateTime string
    The update time.
    CreationTime string
    The create time.
    ResourceId string
    The id of resource.
    ResourceType string
    The type of resource.
    Status string
    The status of the transit router.
    TransitRouterAttachmentId string
    The id of transit router attachment.
    TransitRouterAttachmentName string
    The name of transit router attachment.
    TransitRouterRouteTableId string
    The id of transit router route table.
    UpdateTime string
    The update time.
    creationTime String
    The create time.
    resourceId String
    The id of resource.
    resourceType String
    The type of resource.
    status String
    The status of the transit router.
    transitRouterAttachmentId String
    The id of transit router attachment.
    transitRouterAttachmentName String
    The name of transit router attachment.
    transitRouterRouteTableId String
    The id of transit router route table.
    updateTime String
    The update time.
    creationTime string
    The create time.
    resourceId string
    The id of resource.
    resourceType string
    The type of resource.
    status string
    The status of the transit router.
    transitRouterAttachmentId string
    The id of transit router attachment.
    transitRouterAttachmentName string
    The name of transit router attachment.
    transitRouterRouteTableId string
    The id of transit router route table.
    updateTime string
    The update time.
    creation_time str
    The create time.
    resource_id str
    The id of resource.
    resource_type str
    The type of resource.
    status str
    The status of the transit router.
    transit_router_attachment_id str
    The id of transit router attachment.
    transit_router_attachment_name str
    The name of transit router attachment.
    transit_router_route_table_id str
    The id of transit router route table.
    update_time str
    The update time.
    creationTime String
    The create time.
    resourceId String
    The id of resource.
    resourceType String
    The type of resource.
    status String
    The status of the transit router.
    transitRouterAttachmentId String
    The id of transit router attachment.
    transitRouterAttachmentName String
    The name of transit router attachment.
    transitRouterRouteTableId String
    The id of transit router route table.
    updateTime String
    The update time.

    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