1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. transitrouter
  6. getTransitRouter
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    Data Source schema for Volcengine::TransitRouter::TransitRouter

    Using getTransitRouter

    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 getTransitRouter(args: GetTransitRouterArgs, opts?: InvokeOptions): Promise<GetTransitRouterResult>
    function getTransitRouterOutput(args: GetTransitRouterOutputArgs, opts?: InvokeOptions): Output<GetTransitRouterResult>
    def get_transit_router(id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetTransitRouterResult
    def get_transit_router_output(id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetTransitRouterResult]
    func LookupTransitRouter(ctx *Context, args *LookupTransitRouterArgs, opts ...InvokeOption) (*LookupTransitRouterResult, error)
    func LookupTransitRouterOutput(ctx *Context, args *LookupTransitRouterOutputArgs, opts ...InvokeOption) LookupTransitRouterResultOutput

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

    public static class GetTransitRouter 
    {
        public static Task<GetTransitRouterResult> InvokeAsync(GetTransitRouterArgs args, InvokeOptions? opts = null)
        public static Output<GetTransitRouterResult> Invoke(GetTransitRouterInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTransitRouterResult> getTransitRouter(GetTransitRouterArgs args, InvokeOptions options)
    public static Output<GetTransitRouterResult> getTransitRouter(GetTransitRouterArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:transitrouter/getTransitRouter:getTransitRouter
      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.

    getTransitRouter Result

    The following output properties are available:

    Asn int
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    Attachments List<Volcengine.GetTransitRouterAttachment>
    Detailed information of the network instance connection
    BusinessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    CreationTime string
    Creation time of the network instance connection.
    DeletedTime string
    Deletion time of the network instance connection.
    Description string
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    GrantSourceType string
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    GrantStatus string
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    Id string
    Uniquely identifies the resource.
    MulticastEnabled bool
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    OverdueTime string
    Shutdown time due to overdue payment for the transit router instance
    ProjectName string
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    Status string
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    Tags List<Volcengine.GetTransitRouterTag>
    Tag list
    TransitRouterId string
    Transit router instance ID.
    TransitRouterName string
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    UpdateTime string
    Last operation time of the transit router instance
    Asn int
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    Attachments []GetTransitRouterAttachment
    Detailed information of the network instance connection
    BusinessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    CreationTime string
    Creation time of the network instance connection.
    DeletedTime string
    Deletion time of the network instance connection.
    Description string
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    GrantSourceType string
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    GrantStatus string
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    Id string
    Uniquely identifies the resource.
    MulticastEnabled bool
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    OverdueTime string
    Shutdown time due to overdue payment for the transit router instance
    ProjectName string
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    Status string
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    Tags []GetTransitRouterTag
    Tag list
    TransitRouterId string
    Transit router instance ID.
    TransitRouterName string
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    UpdateTime string
    Last operation time of the transit router instance
    asn Integer
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    attachments List<GetTransitRouterAttachment>
    Detailed information of the network instance connection
    businessStatus String
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime String
    Creation time of the network instance connection.
    deletedTime String
    Deletion time of the network instance connection.
    description String
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    grantSourceType String
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    grantStatus String
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    id String
    Uniquely identifies the resource.
    multicastEnabled Boolean
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    overdueTime String
    Shutdown time due to overdue payment for the transit router instance
    projectName String
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    status String
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags List<GetTransitRouterTag>
    Tag list
    transitRouterId String
    Transit router instance ID.
    transitRouterName String
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    updateTime String
    Last operation time of the transit router instance
    asn number
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    attachments GetTransitRouterAttachment[]
    Detailed information of the network instance connection
    businessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime string
    Creation time of the network instance connection.
    deletedTime string
    Deletion time of the network instance connection.
    description string
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    grantSourceType string
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    grantStatus string
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    id string
    Uniquely identifies the resource.
    multicastEnabled boolean
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    overdueTime string
    Shutdown time due to overdue payment for the transit router instance
    projectName string
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    status string
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags GetTransitRouterTag[]
    Tag list
    transitRouterId string
    Transit router instance ID.
    transitRouterName string
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    updateTime string
    Last operation time of the transit router instance
    asn int
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    attachments Sequence[GetTransitRouterAttachment]
    Detailed information of the network instance connection
    business_status str
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creation_time str
    Creation time of the network instance connection.
    deleted_time str
    Deletion time of the network instance connection.
    description str
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    grant_source_type str
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    grant_status str
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    id str
    Uniquely identifies the resource.
    multicast_enabled bool
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    overdue_time str
    Shutdown time due to overdue payment for the transit router instance
    project_name str
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    status str
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags Sequence[GetTransitRouterTag]
    Tag list
    transit_router_id str
    Transit router instance ID.
    transit_router_name str
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    update_time str
    Last operation time of the transit router instance
    asn Number
    ASN of the transit router. Value range: 64512–65534 and 4200000000–4294967294. Default value: 64512
    attachments List<Property Map>
    Detailed information of the network instance connection
    businessStatus String
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime String
    Creation time of the network instance connection.
    deletedTime String
    Deletion time of the network instance connection.
    description String
    Description of the transit router instance. Must start with a letter, number, or Chinese character. Can contain letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided or no value is entered, the default is an empty string
    grantSourceType String
    Sharing method of the transit router instance. rs: Shared via platform resource sharing. tr: Shared via transit router instance sharing
    grantStatus String
    Instance sharing status. Accepted: Received. Initial: Pending acceptance.
    id String
    Uniquely identifies the resource.
    multicastEnabled Boolean
    Whether multicast is enabled for the transit router. true: enabled. false (default): not enabled
    overdueTime String
    Shutdown time due to overdue payment for the transit router instance
    projectName String
    Name of the project to which the transit router instance belongs. If this parameter is not provided or no value is entered, the default is 'default'
    status String
    Status of the transit router instance. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags List<Property Map>
    Tag list
    transitRouterId String
    Transit router instance ID.
    transitRouterName String
    Name of the transit router instance. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length limit: 1–128 characters. If this parameter is not provided or no value is specified, the default is the transit router instance ID.
    updateTime String
    Last operation time of the transit router instance

    Supporting Types

    GetTransitRouterAttachment

    AutoPublishRouteEnabled bool
    Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    BusinessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    CreationTime string
    Creation time of the network instance connection.
    DeletedTime string
    Deletion time of the network instance connection.
    Description string
    Description of the network instance connection.
    Ipv6Enabled bool
    Whether IPv6 is enabled. true: yes. false: no
    OverdueTime string
    Shutdown time due to overdue payment for the network instance connection
    ResourceId string
    ID of the network instance
    ResourceType string
    Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router
    Status string
    Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    Tags List<Volcengine.GetTransitRouterAttachmentTag>
    Tag information of the network instance connection
    TransitRouterAttachmentId string
    Network instance connection ID.
    TransitRouterAttachmentName string
    Name of the network instance connection
    TransitRouterForwardPolicyTableId string
    ID of the forwarding policy associated with the cross-region connection
    TransitRouterId string
    Transit router instance ID.
    TransitRouterRouteTableId string
    Route table ID associated with the forwarding of the network instance connection.
    TransitRouterTrafficQosMarkingPolicyId string
    ID of the flow marking policy associated with the cross-region connection
    TransitRouterTrafficQosQueuePolicyId string
    ID of the flow queue policy associated with the cross-region connection
    UpdateTime string
    Last operation time of the network instance connection
    AutoPublishRouteEnabled bool
    Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    BusinessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    CreationTime string
    Creation time of the network instance connection.
    DeletedTime string
    Deletion time of the network instance connection.
    Description string
    Description of the network instance connection.
    Ipv6Enabled bool
    Whether IPv6 is enabled. true: yes. false: no
    OverdueTime string
    Shutdown time due to overdue payment for the network instance connection
    ResourceId string
    ID of the network instance
    ResourceType string
    Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router
    Status string
    Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    Tags []GetTransitRouterAttachmentTag
    Tag information of the network instance connection
    TransitRouterAttachmentId string
    Network instance connection ID.
    TransitRouterAttachmentName string
    Name of the network instance connection
    TransitRouterForwardPolicyTableId string
    ID of the forwarding policy associated with the cross-region connection
    TransitRouterId string
    Transit router instance ID.
    TransitRouterRouteTableId string
    Route table ID associated with the forwarding of the network instance connection.
    TransitRouterTrafficQosMarkingPolicyId string
    ID of the flow marking policy associated with the cross-region connection
    TransitRouterTrafficQosQueuePolicyId string
    ID of the flow queue policy associated with the cross-region connection
    UpdateTime string
    Last operation time of the network instance connection
    autoPublishRouteEnabled Boolean
    Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    businessStatus String
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime String
    Creation time of the network instance connection.
    deletedTime String
    Deletion time of the network instance connection.
    description String
    Description of the network instance connection.
    ipv6Enabled Boolean
    Whether IPv6 is enabled. true: yes. false: no
    overdueTime String
    Shutdown time due to overdue payment for the network instance connection
    resourceId String
    ID of the network instance
    resourceType String
    Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router
    status String
    Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags List<GetTransitRouterAttachmentTag>
    Tag information of the network instance connection
    transitRouterAttachmentId String
    Network instance connection ID.
    transitRouterAttachmentName String
    Name of the network instance connection
    transitRouterForwardPolicyTableId String
    ID of the forwarding policy associated with the cross-region connection
    transitRouterId String
    Transit router instance ID.
    transitRouterRouteTableId String
    Route table ID associated with the forwarding of the network instance connection.
    transitRouterTrafficQosMarkingPolicyId String
    ID of the flow marking policy associated with the cross-region connection
    transitRouterTrafficQosQueuePolicyId String
    ID of the flow queue policy associated with the cross-region connection
    updateTime String
    Last operation time of the network instance connection
    autoPublishRouteEnabled boolean
    Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    businessStatus string
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime string
    Creation time of the network instance connection.
    deletedTime string
    Deletion time of the network instance connection.
    description string
    Description of the network instance connection.
    ipv6Enabled boolean
    Whether IPv6 is enabled. true: yes. false: no
    overdueTime string
    Shutdown time due to overdue payment for the network instance connection
    resourceId string
    ID of the network instance
    resourceType string
    Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router
    status string
    Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags GetTransitRouterAttachmentTag[]
    Tag information of the network instance connection
    transitRouterAttachmentId string
    Network instance connection ID.
    transitRouterAttachmentName string
    Name of the network instance connection
    transitRouterForwardPolicyTableId string
    ID of the forwarding policy associated with the cross-region connection
    transitRouterId string
    Transit router instance ID.
    transitRouterRouteTableId string
    Route table ID associated with the forwarding of the network instance connection.
    transitRouterTrafficQosMarkingPolicyId string
    ID of the flow marking policy associated with the cross-region connection
    transitRouterTrafficQosQueuePolicyId string
    ID of the flow queue policy associated with the cross-region connection
    updateTime string
    Last operation time of the network instance connection
    auto_publish_route_enabled bool
    Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    business_status str
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creation_time str
    Creation time of the network instance connection.
    deleted_time str
    Deletion time of the network instance connection.
    description str
    Description of the network instance connection.
    ipv6_enabled bool
    Whether IPv6 is enabled. true: yes. false: no
    overdue_time str
    Shutdown time due to overdue payment for the network instance connection
    resource_id str
    ID of the network instance
    resource_type str
    Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router
    status str
    Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags Sequence[GetTransitRouterAttachmentTag]
    Tag information of the network instance connection
    transit_router_attachment_id str
    Network instance connection ID.
    transit_router_attachment_name str
    Name of the network instance connection
    transit_router_forward_policy_table_id str
    ID of the forwarding policy associated with the cross-region connection
    transit_router_id str
    Transit router instance ID.
    transit_router_route_table_id str
    Route table ID associated with the forwarding of the network instance connection.
    transit_router_traffic_qos_marking_policy_id str
    ID of the flow marking policy associated with the cross-region connection
    transit_router_traffic_qos_queue_policy_id str
    ID of the flow queue policy associated with the cross-region connection
    update_time str
    Last operation time of the network instance connection
    autoPublishRouteEnabled Boolean
    Whether to automatically synchronize TR routes to the network instance route table. true: Yes. false: No.
    businessStatus String
    Business status of the network instance connection. Values: Normal: Normal. FinancialLocked: Financially locked.
    creationTime String
    Creation time of the network instance connection.
    deletedTime String
    Deletion time of the network instance connection.
    description String
    Description of the network instance connection.
    ipv6Enabled Boolean
    Whether IPv6 is enabled. true: yes. false: no
    overdueTime String
    Shutdown time due to overdue payment for the network instance connection
    resourceId String
    ID of the network instance
    resourceType String
    Type of network instance associated with the network instance connection. VPC: Virtual Private Cloud. VPN: VPN connection. DirectConnectGateway: Direct Connect Gateway. TransitRouter: Transit Router
    status String
    Status of the network instance connection. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags List<Property Map>
    Tag information of the network instance connection
    transitRouterAttachmentId String
    Network instance connection ID.
    transitRouterAttachmentName String
    Name of the network instance connection
    transitRouterForwardPolicyTableId String
    ID of the forwarding policy associated with the cross-region connection
    transitRouterId String
    Transit router instance ID.
    transitRouterRouteTableId String
    Route table ID associated with the forwarding of the network instance connection.
    transitRouterTrafficQosMarkingPolicyId String
    ID of the flow marking policy associated with the cross-region connection
    transitRouterTrafficQosQueuePolicyId String
    ID of the flow queue policy associated with the cross-region connection
    updateTime String
    Last operation time of the network instance connection

    GetTransitRouterAttachmentTag

    Key string
    Tag key
    Value string
    Tag value.
    Key string
    Tag key
    Value string
    Tag value.
    key String
    Tag key
    value String
    Tag value.
    key string
    Tag key
    value string
    Tag value.
    key str
    Tag key
    value str
    Tag value.
    key String
    Tag key
    value String
    Tag value.

    GetTransitRouterTag

    Key string
    Tag key
    Value string
    Tag value.
    Key string
    Tag key
    Value string
    Tag value.
    key String
    Tag key
    value String
    Tag value.
    key string
    Tag key
    value string
    Tag value.
    key str
    Tag key
    value str
    Tag value.
    key String
    Tag key
    value String
    Tag value.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.