tencentcloud.getCkafkaTopicFlowRanking

Start a Neo task

Explain and create a tencentcloud.getCkafkaTopicFlowRanking resource

tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

Example Usage

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

const topicFlowRanking = tencentcloud.getCkafkaTopicFlowRanking({
    instanceId: "ckafka-xxxxxx",
    rankingType: "PRO",
    beginDate: "2023-05-29T00:00:00+08:00",
    endDate: "2021-05-29T23:59:59+08:00",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

topic_flow_ranking = tencentcloud.get_ckafka_topic_flow_ranking(instance_id="ckafka-xxxxxx",
    ranking_type="PRO",
    begin_date="2023-05-29T00:00:00+08:00",
    end_date="2021-05-29T23:59:59+08:00")

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 {
		_, err := tencentcloud.LookupCkafkaTopicFlowRanking(ctx, &tencentcloud.LookupCkafkaTopicFlowRankingArgs{
			InstanceId:  "ckafka-xxxxxx",
			RankingType: "PRO",
			BeginDate:   pulumi.StringRef("2023-05-29T00:00:00+08:00"),
			EndDate:     pulumi.StringRef("2021-05-29T23:59:59+08:00"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var topicFlowRanking = Tencentcloud.GetCkafkaTopicFlowRanking.Invoke(new()
    {
        InstanceId = "ckafka-xxxxxx",
        RankingType = "PRO",
        BeginDate = "2023-05-29T00:00:00+08:00",
        EndDate = "2021-05-29T23:59:59+08:00",
    });

});

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.GetCkafkaTopicFlowRankingArgs;
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 topicFlowRanking = TencentcloudFunctions.getCkafkaTopicFlowRanking(GetCkafkaTopicFlowRankingArgs.builder()
            .instanceId("ckafka-xxxxxx")
            .rankingType("PRO")
            .beginDate("2023-05-29T00:00:00+08:00")
            .endDate("2021-05-29T23:59:59+08:00")
            .build());

    }
}

variables:
  topicFlowRanking:
    fn::invoke:
      function: tencentcloud:getCkafkaTopicFlowRanking
      arguments:
        instanceId: ckafka-xxxxxx
        rankingType: PRO
        beginDate: 2023-05-29T00:00:00+08:00
        endDate: 2021-05-29T23:59:59+08:00

Using getCkafkaTopicFlowRanking

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 getCkafkaTopicFlowRanking(args: GetCkafkaTopicFlowRankingArgs, opts?: InvokeOptions): Promise<GetCkafkaTopicFlowRankingResult>
function getCkafkaTopicFlowRankingOutput(args: GetCkafkaTopicFlowRankingOutputArgs, opts?: InvokeOptions): Output<GetCkafkaTopicFlowRankingResult>

def get_ckafka_topic_flow_ranking(begin_date: Optional[str] = None,
                                  end_date: Optional[str] = None,
                                  id: Optional[str] = None,
                                  instance_id: Optional[str] = None,
                                  ranking_type: Optional[str] = None,
                                  result_output_file: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetCkafkaTopicFlowRankingResult
def get_ckafka_topic_flow_ranking_output(begin_date: Optional[pulumi.Input[str]] = None,
                                  end_date: Optional[pulumi.Input[str]] = None,
                                  id: Optional[pulumi.Input[str]] = None,
                                  instance_id: Optional[pulumi.Input[str]] = None,
                                  ranking_type: Optional[pulumi.Input[str]] = None,
                                  result_output_file: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetCkafkaTopicFlowRankingResult]

func LookupCkafkaTopicFlowRanking(ctx *Context, args *LookupCkafkaTopicFlowRankingArgs, opts ...InvokeOption) (*LookupCkafkaTopicFlowRankingResult, error)
func LookupCkafkaTopicFlowRankingOutput(ctx *Context, args *LookupCkafkaTopicFlowRankingOutputArgs, opts ...InvokeOption) LookupCkafkaTopicFlowRankingResultOutput

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

public static class GetCkafkaTopicFlowRanking 
{
    public static Task<GetCkafkaTopicFlowRankingResult> InvokeAsync(GetCkafkaTopicFlowRankingArgs args, InvokeOptions? opts = null)
    public static Output<GetCkafkaTopicFlowRankingResult> Invoke(GetCkafkaTopicFlowRankingInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCkafkaTopicFlowRankingResult> getCkafkaTopicFlowRanking(GetCkafkaTopicFlowRankingArgs args, InvokeOptions options)
public static Output<GetCkafkaTopicFlowRankingResult> getCkafkaTopicFlowRanking(GetCkafkaTopicFlowRankingArgs args, InvokeOptions options)

fn::invoke:
  function: tencentcloud:index/getCkafkaTopicFlowRanking:getCkafkaTopicFlowRanking
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string: InstanceId.
RankingType string: Ranking type. PRO: topic production flow, CON: topic consumption traffic.
BeginDate string: BeginDate.
EndDate string: EndDate.
Id string
ResultOutputFile string: Used to save results.

InstanceId string: InstanceId.
RankingType string: Ranking type. PRO: topic production flow, CON: topic consumption traffic.
BeginDate string: BeginDate.
EndDate string: EndDate.
Id string
ResultOutputFile string: Used to save results.

instanceId String: InstanceId.
rankingType String: Ranking type. PRO: topic production flow, CON: topic consumption traffic.
beginDate String: BeginDate.
endDate String: EndDate.
id String
resultOutputFile String: Used to save results.

instanceId string: InstanceId.
rankingType string: Ranking type. PRO: topic production flow, CON: topic consumption traffic.
beginDate string: BeginDate.
endDate string: EndDate.
id string
resultOutputFile string: Used to save results.

instance_id str: InstanceId.
ranking_type str: Ranking type. PRO: topic production flow, CON: topic consumption traffic.
begin_date str: BeginDate.
end_date str: EndDate.
id str
result_output_file str: Used to save results.

instanceId String: InstanceId.
rankingType String: Ranking type. PRO: topic production flow, CON: topic consumption traffic.
beginDate String: BeginDate.
endDate String: EndDate.
id String
resultOutputFile String: Used to save results.