Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Tencentcloud Provider
  4. API Docs
  5. getCkafkaRoutes
Viewing docs for tencentcloud 1.83.31
published on Friday, Sep 11, 2026 by tencentcloudstack
Schema (JSON)
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getCkafkaRoutes

Viewing docs for tencentcloud 1.83.31
published on Friday, Sep 11, 2026 by tencentcloudstack
Schema (JSON)
tencentcloudstack/terraform-provider-tencentcloud

    Use this data source to query detailed information of CKafka routes

    Example Usage

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

const example = tencentcloud.getCkafkaRoutes({
    instanceId: "ckafka-exampleabc",
    mainRouteFlag: true,
    routeId: 123,
});
export const routes = example.then(example => example.routers);

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_ckafka_routes(instance_id="ckafka-exampleabc",
    main_route_flag=True,
    route_id=123)
pulumi.export("routes", example.routers)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := tencentcloud.GetCkafkaRoutes(ctx, &tencentcloud.GetCkafkaRoutesArgs{
			InstanceId:    "ckafka-exampleabc",
			MainRouteFlag: pulumi.BoolRef(true),
			RouteId:       pulumi.Float64Ref(123),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("routes", example.Routers)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetCkafkaRoutes.Invoke(new()
    {
        InstanceId = "ckafka-exampleabc",
        MainRouteFlag = true,
        RouteId = 123,
    });

    return new Dictionary<string, object?>
    {
        ["routes"] = example.Apply(getCkafkaRoutesResult => getCkafkaRoutesResult.Routers),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetCkafkaRoutesArgs;
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 example = TencentcloudFunctions.getCkafkaRoutes(GetCkafkaRoutesArgs.builder()
            .instanceId("ckafka-exampleabc")
            .mainRouteFlag(true)
            .routeId(123)
            .build());

        ctx.export("routes", example.routers());
    }
}

    variables:
  example:
    fn::invoke:
      function: tencentcloud:getCkafkaRoutes
      arguments:
        instanceId: ckafka-exampleabc
        mainRouteFlag: true
        routeId: 123
outputs:
  routes: ${example.routers}

    Example coming soon!

    Using getCkafkaRoutes

    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 getCkafkaRoutes(args: GetCkafkaRoutesArgs, opts?: InvokeOptions): Promise<GetCkafkaRoutesResult>
function getCkafkaRoutesOutput(args: GetCkafkaRoutesOutputArgs, opts?: InvokeOutputOptions): Output<GetCkafkaRoutesResult>
    def get_ckafka_routes(id: Optional[str] = None,
                      instance_id: Optional[str] = None,
                      main_route_flag: Optional[bool] = None,
                      result_output_file: Optional[str] = None,
                      route_id: Optional[float] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCkafkaRoutesResult
def get_ckafka_routes_output(id: pulumi.Input[Optional[str]] = None,
                      instance_id: pulumi.Input[Optional[str]] = None,
                      main_route_flag: pulumi.Input[Optional[bool]] = None,
                      result_output_file: pulumi.Input[Optional[str]] = None,
                      route_id: pulumi.Input[Optional[float]] = None,
                      opts: Optional[InvokeOutputOptions] = None) -> Output[GetCkafkaRoutesResult]
    func GetCkafkaRoutes(ctx *Context, args *GetCkafkaRoutesArgs, opts ...InvokeOption) (*GetCkafkaRoutesResult, error)
func GetCkafkaRoutesOutput(ctx *Context, args *GetCkafkaRoutesOutputArgs, opts ...InvokeOption) GetCkafkaRoutesResultOutput

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

    public static class GetCkafkaRoutes 
{
    public static Task<GetCkafkaRoutesResult> InvokeAsync(GetCkafkaRoutesArgs args, InvokeOptions? opts = null)
    public static Output<GetCkafkaRoutesResult> Invoke(GetCkafkaRoutesInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetCkafkaRoutesResult> Invoke(GetCkafkaRoutesInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetCkafkaRoutesResult> getCkafkaRoutes(GetCkafkaRoutesArgs args, InvokeOptions options)
public static Output<GetCkafkaRoutesResult> getCkafkaRoutes(GetCkafkaRoutesArgs args, InvokeOptions options)
public static Output<GetCkafkaRoutesResult> getCkafkaRoutes(GetCkafkaRoutesArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: tencentcloud:index/getCkafkaRoutes:getCkafkaRoutes
  arguments:
    # arguments dictionary
    data "tencentcloud_get_ckafka_routes" "name" {
    # arguments
}

    The following arguments are supported:

    InstanceId string
    Id of the ckafka instance.
    Id string
    MainRouteFlag bool
    Whether to display the main route. When set to true, the main route created at instance creation will be additionally returned.
    ResultOutputFile string
    Used to save results.
    RouteId double
    Route id, used to query a specific route.
    InstanceId string
    Id of the ckafka instance.
    Id string
    MainRouteFlag bool
    Whether to display the main route. When set to true, the main route created at instance creation will be additionally returned.
    ResultOutputFile string
    Used to save results.
    RouteId float64
    Route id, used to query a specific route.
    instance_id string
    Id of the ckafka instance.
    id string
    main_route_flag bool
    Whether to display the main route. When set to true, the main route created at instance creation will be additionally returned.
    result_output_file string
    Used to save results.
    route_id number
    Route id, used to query a specific route.
    instanceId String
    Id of the ckafka instance.
    id String
    mainRouteFlag Boolean
    Whether to display the main route. When set to true, the main route created at instance creation will be additionally returned.
    resultOutputFile String
    Used to save results.
    routeId Double
    Route id, used to query a specific route.
    instanceId string
    Id of the ckafka instance.
    id string
    mainRouteFlag boolean
    Whether to display the main route. When set to true, the main route created at instance creation will be additionally returned.
    resultOutputFile string
    Used to save results.
    routeId number
    Route id, used to query a specific route.
    instance_id str
    Id of the ckafka instance.
    id str
    main_route_flag bool
    Whether to display the main route. When set to true, the main route created at instance creation will be additionally returned.
    result_output_file str
    Used to save results.
    route_id float
    Route id, used to query a specific route.
    instanceId String
    Id of the ckafka instance.
    id String
    mainRouteFlag Boolean
    Whether to display the main route. When set to true, the main route created at instance creation will be additionally returned.
    resultOutputFile String
    Used to save results.
    routeId Number
    Route id, used to query a specific route.

    getCkafkaRoutes Result

    The following output properties are available:

    Id string
    InstanceId string
    Routers List<GetCkafkaRoutesRouter>
    A list of ckafka routes. Each element contains the following attributes:
    MainRouteFlag bool
    ResultOutputFile string
    RouteId double
    Route id.
    Id string
    InstanceId string
    Routers []GetCkafkaRoutesRouter
    A list of ckafka routes. Each element contains the following attributes:
    MainRouteFlag bool
    ResultOutputFile string
    RouteId float64
    Route id.
    id string
    instance_id string
    routers list(object)
    A list of ckafka routes. Each element contains the following attributes:
    main_route_flag bool
    result_output_file string
    route_id number
    Route id.
    id String
    instanceId String
    routers List<GetCkafkaRoutesRouter>
    A list of ckafka routes. Each element contains the following attributes:
    mainRouteFlag Boolean
    resultOutputFile String
    routeId Double
    Route id.
    id string
    instanceId string
    routers GetCkafkaRoutesRouter[]
    A list of ckafka routes. Each element contains the following attributes:
    mainRouteFlag boolean
    resultOutputFile string
    routeId number
    Route id.
    id str
    instance_id str
    routers Sequence[GetCkafkaRoutesRouter]
    A list of ckafka routes. Each element contains the following attributes:
    main_route_flag bool
    result_output_file str
    route_id float
    Route id.
    id String
    instanceId String
    routers List<Property Map>
    A list of ckafka routes. Each element contains the following attributes:
    mainRouteFlag Boolean
    resultOutputFile String
    routeId Number
    Route id.

    Supporting Types

    GetCkafkaRoutesRouter

    AccessType double
    Instance access type. 0: PLAINTEXT, 1: SASL_PLAINTEXT, 2: SSL, 3: SASL_SSL.
    BrokerVipLists List<GetCkafkaRoutesRouterBrokerVipList>
    Virtual IP list (1 to 1 broker nodes).
    DeleteTimestamp string
    Delete timestamp.
    Domain string
    Domain.
    DomainPort double
    Domain port.
    Note string
    Remark.
    RouteId double
    Route id, used to query a specific route.
    Status double
    Route status. 1: creating, 2: created, 3: create failed, 4: deleting, 6: delete failed.
    Subnet string
    Subnet id.
    VipLists List<GetCkafkaRoutesRouterVipList>
    Virtual IP list.
    VipType double
    Routing network type. 3: vpc routing, 7: internal support routing, 1: public network routing.
    VpcId string
    Vpc id.
    AccessType float64
    Instance access type. 0: PLAINTEXT, 1: SASL_PLAINTEXT, 2: SSL, 3: SASL_SSL.
    BrokerVipLists []GetCkafkaRoutesRouterBrokerVipList
    Virtual IP list (1 to 1 broker nodes).
    DeleteTimestamp string
    Delete timestamp.
    Domain string
    Domain.
    DomainPort float64
    Domain port.
    Note string
    Remark.
    RouteId float64
    Route id, used to query a specific route.
    Status float64
    Route status. 1: creating, 2: created, 3: create failed, 4: deleting, 6: delete failed.
    Subnet string
    Subnet id.
    VipLists []GetCkafkaRoutesRouterVipList
    Virtual IP list.
    VipType float64
    Routing network type. 3: vpc routing, 7: internal support routing, 1: public network routing.
    VpcId string
    Vpc id.
    access_type number
    Instance access type. 0: PLAINTEXT, 1: SASL_PLAINTEXT, 2: SSL, 3: SASL_SSL.
    broker_vip_lists list(object)
    Virtual IP list (1 to 1 broker nodes).
    delete_timestamp string
    Delete timestamp.
    domain string
    Domain.
    domain_port number
    Domain port.
    note string
    Remark.
    route_id number
    Route id, used to query a specific route.
    status number
    Route status. 1: creating, 2: created, 3: create failed, 4: deleting, 6: delete failed.
    subnet string
    Subnet id.
    vip_lists list(object)
    Virtual IP list.
    vip_type number
    Routing network type. 3: vpc routing, 7: internal support routing, 1: public network routing.
    vpc_id string
    Vpc id.
    accessType Double
    Instance access type. 0: PLAINTEXT, 1: SASL_PLAINTEXT, 2: SSL, 3: SASL_SSL.
    brokerVipLists List<GetCkafkaRoutesRouterBrokerVipList>
    Virtual IP list (1 to 1 broker nodes).
    deleteTimestamp String
    Delete timestamp.
    domain String
    Domain.
    domainPort Double
    Domain port.
    note String
    Remark.
    routeId Double
    Route id, used to query a specific route.
    status Double
    Route status. 1: creating, 2: created, 3: create failed, 4: deleting, 6: delete failed.
    subnet String
    Subnet id.
    vipLists List<GetCkafkaRoutesRouterVipList>
    Virtual IP list.
    vipType Double
    Routing network type. 3: vpc routing, 7: internal support routing, 1: public network routing.
    vpcId String
    Vpc id.
    accessType number
    Instance access type. 0: PLAINTEXT, 1: SASL_PLAINTEXT, 2: SSL, 3: SASL_SSL.
    brokerVipLists GetCkafkaRoutesRouterBrokerVipList[]
    Virtual IP list (1 to 1 broker nodes).
    deleteTimestamp string
    Delete timestamp.
    domain string
    Domain.
    domainPort number
    Domain port.
    note string
    Remark.
    routeId number
    Route id, used to query a specific route.
    status number
    Route status. 1: creating, 2: created, 3: create failed, 4: deleting, 6: delete failed.
    subnet string
    Subnet id.
    vipLists GetCkafkaRoutesRouterVipList[]
    Virtual IP list.
    vipType number
    Routing network type. 3: vpc routing, 7: internal support routing, 1: public network routing.
    vpcId string
    Vpc id.
    access_type float
    Instance access type. 0: PLAINTEXT, 1: SASL_PLAINTEXT, 2: SSL, 3: SASL_SSL.
    broker_vip_lists Sequence[GetCkafkaRoutesRouterBrokerVipList]
    Virtual IP list (1 to 1 broker nodes).
    delete_timestamp str
    Delete timestamp.
    domain str
    Domain.
    domain_port float
    Domain port.
    note str
    Remark.
    route_id float
    Route id, used to query a specific route.
    status float
    Route status. 1: creating, 2: created, 3: create failed, 4: deleting, 6: delete failed.
    subnet str
    Subnet id.
    vip_lists Sequence[GetCkafkaRoutesRouterVipList]
    Virtual IP list.
    vip_type float
    Routing network type. 3: vpc routing, 7: internal support routing, 1: public network routing.
    vpc_id str
    Vpc id.
    accessType Number
    Instance access type. 0: PLAINTEXT, 1: SASL_PLAINTEXT, 2: SSL, 3: SASL_SSL.
    brokerVipLists List<Property Map>
    Virtual IP list (1 to 1 broker nodes).
    deleteTimestamp String
    Delete timestamp.
    domain String
    Domain.
    domainPort Number
    Domain port.
    note String
    Remark.
    routeId Number
    Route id, used to query a specific route.
    status Number
    Route status. 1: creating, 2: created, 3: create failed, 4: deleting, 6: delete failed.
    subnet String
    Subnet id.
    vipLists List<Property Map>
    Virtual IP list.
    vipType Number
    Routing network type. 3: vpc routing, 7: internal support routing, 1: public network routing.
    vpcId String
    Vpc id.

    GetCkafkaRoutesRouterBrokerVipList

    Vip string
    Virtual IP.
    Vport string
    Virtual port.
    Vip string
    Virtual IP.
    Vport string
    Virtual port.
    vip string
    Virtual IP.
    vport string
    Virtual port.
    vip String
    Virtual IP.
    vport String
    Virtual port.
    vip string
    Virtual IP.
    vport string
    Virtual port.
    vip str
    Virtual IP.
    vport str
    Virtual port.
    vip String
    Virtual IP.
    vport String
    Virtual port.

    GetCkafkaRoutesRouterVipList

    Vip string
    Virtual IP.
    Vport string
    Virtual port.
    Vip string
    Virtual IP.
    Vport string
    Virtual port.
    vip string
    Virtual IP.
    vport string
    Virtual port.
    vip String
    Virtual IP.
    vport String
    Virtual port.
    vip string
    Virtual IP.
    vport string
    Virtual port.
    vip str
    Virtual IP.
    vport str
    Virtual port.
    vip String
    Virtual IP.
    vport String
    Virtual port.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    Viewing docs for tencentcloud 1.83.31
    published on Friday, Sep 11, 2026 by tencentcloudstack
    Schema (JSON)
    tencentcloudstack/terraform-provider-tencentcloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial