bytepluscc.transitrouter.getTransitRouter

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

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: bytepluscc: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号。取值范围为64512 ～ 65534 和 4200000000 ～ 4294967294，默认值为64512。
Attachments List<Byteplus.GetTransitRouterAttachment>: 网络实例连接的详细信息。
BusinessStatus string: 网络实例连接的业务状态。取值如下：Normal：正常。FinancialLocked：已冻结。
CreationTime string: 网络实例连接的创建时间。
DeletedTime string: 网络实例连接的删除时间。
Description string: 中转路由器实例的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
GrantStatus string: 实例共享的状态。Accepted：已接受。Initial：待接受。
Id string: Uniquely identifies the resource.
OverdueTime string: 中转路由器实例的欠费关停时间。
ProjectName string: 中转路由器实例所属项目的名称。不传入该参数或该参数不传入数值时，默认为default。
Status string: 中转路由器实例的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
Tags List<Byteplus.GetTransitRouterTag>: 标签列表
TransitRouterId string: 中转路由器实例的ID。
TransitRouterName string: 中转路由器实例的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为中转路由器实例的ID。
UpdateTime string: 中转路由器实例的最近操作时间。

Asn int: 中转路由器的ASN号。取值范围为64512 ～ 65534 和 4200000000 ～ 4294967294，默认值为64512。
Attachments []GetTransitRouterAttachment: 网络实例连接的详细信息。
BusinessStatus string: 网络实例连接的业务状态。取值如下：Normal：正常。FinancialLocked：已冻结。
CreationTime string: 网络实例连接的创建时间。
DeletedTime string: 网络实例连接的删除时间。
Description string: 中转路由器实例的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
GrantStatus string: 实例共享的状态。Accepted：已接受。Initial：待接受。
Id string: Uniquely identifies the resource.
OverdueTime string: 中转路由器实例的欠费关停时间。
ProjectName string: 中转路由器实例所属项目的名称。不传入该参数或该参数不传入数值时，默认为default。
Status string: 中转路由器实例的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
Tags []GetTransitRouterTag: 标签列表
TransitRouterId string: 中转路由器实例的ID。
TransitRouterName string: 中转路由器实例的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为中转路由器实例的ID。
UpdateTime string: 中转路由器实例的最近操作时间。

asn Integer: 中转路由器的ASN号。取值范围为64512 ～ 65534 和 4200000000 ～ 4294967294，默认值为64512。
attachments List<GetTransitRouterAttachment>: 网络实例连接的详细信息。
businessStatus String: 网络实例连接的业务状态。取值如下：Normal：正常。FinancialLocked：已冻结。
creationTime String: 网络实例连接的创建时间。
deletedTime String: 网络实例连接的删除时间。
description String: 中转路由器实例的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
grantStatus String: 实例共享的状态。Accepted：已接受。Initial：待接受。
id String: Uniquely identifies the resource.
overdueTime String: 中转路由器实例的欠费关停时间。
projectName String: 中转路由器实例所属项目的名称。不传入该参数或该参数不传入数值时，默认为default。
status String: 中转路由器实例的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
tags List<GetTransitRouterTag>: 标签列表
transitRouterId String: 中转路由器实例的ID。
transitRouterName String: 中转路由器实例的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为中转路由器实例的ID。
updateTime String: 中转路由器实例的最近操作时间。

asn number: 中转路由器的ASN号。取值范围为64512 ～ 65534 和 4200000000 ～ 4294967294，默认值为64512。
attachments GetTransitRouterAttachment[]: 网络实例连接的详细信息。
businessStatus string: 网络实例连接的业务状态。取值如下：Normal：正常。FinancialLocked：已冻结。
creationTime string: 网络实例连接的创建时间。
deletedTime string: 网络实例连接的删除时间。
description string: 中转路由器实例的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
grantStatus string: 实例共享的状态。Accepted：已接受。Initial：待接受。
id string: Uniquely identifies the resource.
overdueTime string: 中转路由器实例的欠费关停时间。
projectName string: 中转路由器实例所属项目的名称。不传入该参数或该参数不传入数值时，默认为default。
status string: 中转路由器实例的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
tags GetTransitRouterTag[]: 标签列表
transitRouterId string: 中转路由器实例的ID。
transitRouterName string: 中转路由器实例的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为中转路由器实例的ID。
updateTime string: 中转路由器实例的最近操作时间。

asn int: 中转路由器的ASN号。取值范围为64512 ～ 65534 和 4200000000 ～ 4294967294，默认值为64512。
attachments Sequence[GetTransitRouterAttachment]: 网络实例连接的详细信息。
business_status str: 网络实例连接的业务状态。取值如下：Normal：正常。FinancialLocked：已冻结。
creation_time str: 网络实例连接的创建时间。
deleted_time str: 网络实例连接的删除时间。
description str: 中转路由器实例的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
grant_status str: 实例共享的状态。Accepted：已接受。Initial：待接受。
id str: Uniquely identifies the resource.
overdue_time str: 中转路由器实例的欠费关停时间。
project_name str: 中转路由器实例所属项目的名称。不传入该参数或该参数不传入数值时，默认为default。
status str: 中转路由器实例的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
tags Sequence[GetTransitRouterTag]: 标签列表
transit_router_id str: 中转路由器实例的ID。
transit_router_name str: 中转路由器实例的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为中转路由器实例的ID。
update_time str: 中转路由器实例的最近操作时间。

asn Number: 中转路由器的ASN号。取值范围为64512 ～ 65534 和 4200000000 ～ 4294967294，默认值为64512。
attachments List<Property Map>: 网络实例连接的详细信息。
businessStatus String: 网络实例连接的业务状态。取值如下：Normal：正常。FinancialLocked：已冻结。
creationTime String: 网络实例连接的创建时间。
deletedTime String: 网络实例连接的删除时间。
description String: 中转路由器实例的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不传入该参数或该参数不传入数值时，默认为空字符串。
grantStatus String: 实例共享的状态。Accepted：已接受。Initial：待接受。
id String: Uniquely identifies the resource.
overdueTime String: 中转路由器实例的欠费关停时间。
projectName String: 中转路由器实例所属项目的名称。不传入该参数或该参数不传入数值时，默认为default。
status String: 中转路由器实例的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
tags List<Property Map>: 标签列表
transitRouterId String: 中转路由器实例的ID。
transitRouterName String: 中转路由器实例的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为中转路由器实例的ID。
updateTime String: 中转路由器实例的最近操作时间。

Supporting Types

GetTransitRouterAttachment

AutoPublishRouteEnabled bool: 是否自动同步TR路由到网络实例路由表中。true：是。false：否。
BusinessStatus string: 网络实例连接的业务状态。取值如下：Normal：正常。FinancialLocked：已冻结。
CreationTime string: 网络实例连接的创建时间。
DeletedTime string: 网络实例连接的删除时间。
Description string: 网络实例连接的描述信息。
Ipv6Enabled bool: 是否开启IPv6功能。true：是。false：否。
OverdueTime string: 网络实例连接的欠费关停时间。
ResourceId string: 网络实例的ID。
ResourceType string: 网络实例连接关联的网络实例类型。VPC：私有网络。VPN：VPN连接。DirectConnectGateway：专线网关。TransitRouter：中转路由器。
Status string: 网络实例连接的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
Tags List<Byteplus.GetTransitRouterAttachmentTag>: 网络实例连接的标签信息
TransitRouterAttachmentId string: 网络实例连接的ID。
TransitRouterAttachmentName string: 网络实例连接的名称。
TransitRouterForwardPolicyTableId string: 跨地域连接关联的转发策略的ID。
TransitRouterId string: 中转路由器实例的ID。
TransitRouterRouteTableId string: 网络实例连接关联转发的路由表ID。
TransitRouterTrafficQosMarkingPolicyId string: 跨地域连接关联的流标记策略的ID。
TransitRouterTrafficQosQueuePolicyId string: 跨地域连接关联的流队列策略的ID。
UpdateTime string: 网络实例连接的最近操作时间。

AutoPublishRouteEnabled bool: 是否自动同步TR路由到网络实例路由表中。true：是。false：否。
BusinessStatus string: 网络实例连接的业务状态。取值如下：Normal：正常。FinancialLocked：已冻结。
CreationTime string: 网络实例连接的创建时间。
DeletedTime string: 网络实例连接的删除时间。
Description string: 网络实例连接的描述信息。
Ipv6Enabled bool: 是否开启IPv6功能。true：是。false：否。
OverdueTime string: 网络实例连接的欠费关停时间。
ResourceId string: 网络实例的ID。
ResourceType string: 网络实例连接关联的网络实例类型。VPC：私有网络。VPN：VPN连接。DirectConnectGateway：专线网关。TransitRouter：中转路由器。
Status string: 网络实例连接的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
Tags []GetTransitRouterAttachmentTag: 网络实例连接的标签信息
TransitRouterAttachmentId string: 网络实例连接的ID。
TransitRouterAttachmentName string: 网络实例连接的名称。
TransitRouterForwardPolicyTableId string: 跨地域连接关联的转发策略的ID。
TransitRouterId string: 中转路由器实例的ID。
TransitRouterRouteTableId string: 网络实例连接关联转发的路由表ID。
TransitRouterTrafficQosMarkingPolicyId string: 跨地域连接关联的流标记策略的ID。
TransitRouterTrafficQosQueuePolicyId string: 跨地域连接关联的流队列策略的ID。
UpdateTime string: 网络实例连接的最近操作时间。

autoPublishRouteEnabled Boolean: 是否自动同步TR路由到网络实例路由表中。true：是。false：否。
businessStatus String: 网络实例连接的业务状态。取值如下：Normal：正常。FinancialLocked：已冻结。
creationTime String: 网络实例连接的创建时间。
deletedTime String: 网络实例连接的删除时间。
description String: 网络实例连接的描述信息。
ipv6Enabled Boolean: 是否开启IPv6功能。true：是。false：否。
overdueTime String: 网络实例连接的欠费关停时间。
resourceId String: 网络实例的ID。
resourceType String: 网络实例连接关联的网络实例类型。VPC：私有网络。VPN：VPN连接。DirectConnectGateway：专线网关。TransitRouter：中转路由器。
status String: 网络实例连接的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
tags List<GetTransitRouterAttachmentTag>: 网络实例连接的标签信息
transitRouterAttachmentId String: 网络实例连接的ID。
transitRouterAttachmentName String: 网络实例连接的名称。
transitRouterForwardPolicyTableId String: 跨地域连接关联的转发策略的ID。
transitRouterId String: 中转路由器实例的ID。
transitRouterRouteTableId String: 网络实例连接关联转发的路由表ID。
transitRouterTrafficQosMarkingPolicyId String: 跨地域连接关联的流标记策略的ID。
transitRouterTrafficQosQueuePolicyId String: 跨地域连接关联的流队列策略的ID。
updateTime String: 网络实例连接的最近操作时间。

autoPublishRouteEnabled boolean: 是否自动同步TR路由到网络实例路由表中。true：是。false：否。
businessStatus string: 网络实例连接的业务状态。取值如下：Normal：正常。FinancialLocked：已冻结。
creationTime string: 网络实例连接的创建时间。
deletedTime string: 网络实例连接的删除时间。
description string: 网络实例连接的描述信息。
ipv6Enabled boolean: 是否开启IPv6功能。true：是。false：否。
overdueTime string: 网络实例连接的欠费关停时间。
resourceId string: 网络实例的ID。
resourceType string: 网络实例连接关联的网络实例类型。VPC：私有网络。VPN：VPN连接。DirectConnectGateway：专线网关。TransitRouter：中转路由器。
status string: 网络实例连接的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
tags GetTransitRouterAttachmentTag[]: 网络实例连接的标签信息
transitRouterAttachmentId string: 网络实例连接的ID。
transitRouterAttachmentName string: 网络实例连接的名称。
transitRouterForwardPolicyTableId string: 跨地域连接关联的转发策略的ID。
transitRouterId string: 中转路由器实例的ID。
transitRouterRouteTableId string: 网络实例连接关联转发的路由表ID。
transitRouterTrafficQosMarkingPolicyId string: 跨地域连接关联的流标记策略的ID。
transitRouterTrafficQosQueuePolicyId string: 跨地域连接关联的流队列策略的ID。
updateTime string: 网络实例连接的最近操作时间。

auto_publish_route_enabled bool: 是否自动同步TR路由到网络实例路由表中。true：是。false：否。
business_status str: 网络实例连接的业务状态。取值如下：Normal：正常。FinancialLocked：已冻结。
creation_time str: 网络实例连接的创建时间。
deleted_time str: 网络实例连接的删除时间。
description str: 网络实例连接的描述信息。
ipv6_enabled bool: 是否开启IPv6功能。true：是。false：否。
overdue_time str: 网络实例连接的欠费关停时间。
resource_id str: 网络实例的ID。
resource_type str: 网络实例连接关联的网络实例类型。VPC：私有网络。VPN：VPN连接。DirectConnectGateway：专线网关。TransitRouter：中转路由器。
status str: 网络实例连接的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
tags Sequence[GetTransitRouterAttachmentTag]: 网络实例连接的标签信息
transit_router_attachment_id str: 网络实例连接的ID。
transit_router_attachment_name str: 网络实例连接的名称。
transit_router_forward_policy_table_id str: 跨地域连接关联的转发策略的ID。
transit_router_id str: 中转路由器实例的ID。
transit_router_route_table_id str: 网络实例连接关联转发的路由表ID。
transit_router_traffic_qos_marking_policy_id str: 跨地域连接关联的流标记策略的ID。
transit_router_traffic_qos_queue_policy_id str: 跨地域连接关联的流队列策略的ID。
update_time str: 网络实例连接的最近操作时间。

autoPublishRouteEnabled Boolean: 是否自动同步TR路由到网络实例路由表中。true：是。false：否。
businessStatus String: 网络实例连接的业务状态。取值如下：Normal：正常。FinancialLocked：已冻结。
creationTime String: 网络实例连接的创建时间。
deletedTime String: 网络实例连接的删除时间。
description String: 网络实例连接的描述信息。
ipv6Enabled Boolean: 是否开启IPv6功能。true：是。false：否。
overdueTime String: 网络实例连接的欠费关停时间。
resourceId String: 网络实例的ID。
resourceType String: 网络实例连接关联的网络实例类型。VPC：私有网络。VPN：VPN连接。DirectConnectGateway：专线网关。TransitRouter：中转路由器。
status String: 网络实例连接的状态。Creating: 创建中。Deleting: 删除中。Pending：配置中。Available：可用。
tags List<Property Map>: 网络实例连接的标签信息
transitRouterAttachmentId String: 网络实例连接的ID。
transitRouterAttachmentName String: 网络实例连接的名称。
transitRouterForwardPolicyTableId String: 跨地域连接关联的转发策略的ID。
transitRouterId String: 中转路由器实例的ID。
transitRouterRouteTableId String: 网络实例连接关联转发的路由表ID。
transitRouterTrafficQosMarkingPolicyId String: 跨地域连接关联的流标记策略的ID。
transitRouterTrafficQosQueuePolicyId String: 跨地域连接关联的流队列策略的ID。
updateTime String: 网络实例连接的最近操作时间。

GetTransitRouterAttachmentTag

Key string: 标签键。
Value string: 标签值。

Key string: 标签键。
Value string: 标签值。

key String: 标签键。
value String: 标签值。

key string: 标签键。
value string: 标签值。

key str: 标签键。
value str: 标签值。

key String: 标签键。
value String: 标签值。

GetTransitRouterTag

Key string: 标签键。
Value string: 标签值。

Key string: 标签键。
Value string: 标签值。

key String: 标签键。
value String: 标签值。

key string: 标签键。
value string: 标签值。

key str: 标签键。
value str: 标签值。

key String: 标签键。
value String: 标签值。

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.transitrouter.getTransitRouter

On this page

On this page

Using getTransitRouter

getTransitRouter Result

Supporting Types

GetTransitRouterAttachment

GetTransitRouterAttachmentTag

GetTransitRouterTag

Package Details

On this page

On this page