1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getCkafkaTopicFlowRanking
tencentcloud 1.81.182 published on Monday, Apr 14, 2025 by tencentcloudstack

tencentcloud.getCkafkaTopicFlowRanking

Explore with Pulumi AI

Use this data source to query detailed information of ckafka topic_flow_ranking

Example Usage

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

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

topic_flow_ranking = tencentcloud.get_ckafka_topic_flow_ranking(begin_date="2023-05-29T00:00:00+08:00",
    end_date="2021-05-29T23:59:59+08:00",
    instance_id="ckafka-xxxxxx",
    ranking_type="PRO")
Copy
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{
			BeginDate:   pulumi.StringRef("2023-05-29T00:00:00+08:00"),
			EndDate:     pulumi.StringRef("2021-05-29T23:59:59+08:00"),
			InstanceId:  "ckafka-xxxxxx",
			RankingType: "PRO",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

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

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

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

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>
Copy
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]
Copy
func LookupCkafkaTopicFlowRanking(ctx *Context, args *LookupCkafkaTopicFlowRankingArgs, opts ...InvokeOption) (*LookupCkafkaTopicFlowRankingResult, error)
func LookupCkafkaTopicFlowRankingOutput(ctx *Context, args *LookupCkafkaTopicFlowRankingOutputArgs, opts ...InvokeOption) LookupCkafkaTopicFlowRankingResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetCkafkaTopicFlowRankingResult> getCkafkaTopicFlowRanking(GetCkafkaTopicFlowRankingArgs args, InvokeOptions options)
public static Output<GetCkafkaTopicFlowRankingResult> getCkafkaTopicFlowRanking(GetCkafkaTopicFlowRankingArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: tencentcloud:index/getCkafkaTopicFlowRanking:getCkafkaTopicFlowRanking
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceId This property is required. string
InstanceId.
RankingType This property is required. 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 This property is required. string
InstanceId.
RankingType This property is required. 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 This property is required. String
InstanceId.
rankingType This property is required. 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 This property is required. string
InstanceId.
rankingType This property is required. 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 This property is required. str
InstanceId.
ranking_type This property is required. 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 This property is required. String
InstanceId.
rankingType This property is required. 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.

getCkafkaTopicFlowRanking Result

The following output properties are available:

Supporting Types

GetCkafkaTopicFlowRankingResult

ConsumeSpeeds This property is required. List<GetCkafkaTopicFlowRankingResultConsumeSpeed>
ConsumeSpeed.
TopicFlows This property is required. List<GetCkafkaTopicFlowRankingResultTopicFlow>
TopicFlow.
TopicMessageHeaps This property is required. List<GetCkafkaTopicFlowRankingResultTopicMessageHeap>
TopicMessageHeapRanking.
ConsumeSpeeds This property is required. []GetCkafkaTopicFlowRankingResultConsumeSpeed
ConsumeSpeed.
TopicFlows This property is required. []GetCkafkaTopicFlowRankingResultTopicFlow
TopicFlow.
TopicMessageHeaps This property is required. []GetCkafkaTopicFlowRankingResultTopicMessageHeap
TopicMessageHeapRanking.
consumeSpeeds This property is required. List<GetCkafkaTopicFlowRankingResultConsumeSpeed>
ConsumeSpeed.
topicFlows This property is required. List<GetCkafkaTopicFlowRankingResultTopicFlow>
TopicFlow.
topicMessageHeaps This property is required. List<GetCkafkaTopicFlowRankingResultTopicMessageHeap>
TopicMessageHeapRanking.
consumeSpeeds This property is required. GetCkafkaTopicFlowRankingResultConsumeSpeed[]
ConsumeSpeed.
topicFlows This property is required. GetCkafkaTopicFlowRankingResultTopicFlow[]
TopicFlow.
topicMessageHeaps This property is required. GetCkafkaTopicFlowRankingResultTopicMessageHeap[]
TopicMessageHeapRanking.
consumeSpeeds This property is required. List<Property Map>
ConsumeSpeed.
topicFlows This property is required. List<Property Map>
TopicFlow.
topicMessageHeaps This property is required. List<Property Map>
TopicMessageHeapRanking.

GetCkafkaTopicFlowRankingResultConsumeSpeed

ConsumerGroupName This property is required. string
ConsumerGroupName.
Speed This property is required. double
Speed.
ConsumerGroupName This property is required. string
ConsumerGroupName.
Speed This property is required. float64
Speed.
consumerGroupName This property is required. String
ConsumerGroupName.
speed This property is required. Double
Speed.
consumerGroupName This property is required. string
ConsumerGroupName.
speed This property is required. number
Speed.
consumer_group_name This property is required. str
ConsumerGroupName.
speed This property is required. float
Speed.
consumerGroupName This property is required. String
ConsumerGroupName.
speed This property is required. Number
Speed.

GetCkafkaTopicFlowRankingResultTopicFlow

MessageHeap This property is required. double
Topic MessageHeap.
PartitionNum This property is required. double
PartitionNum.
ReplicaNum This property is required. double
ReplicaNum.
TopicId This property is required. string
topicId.
TopicName This property is required. string
topicName.
TopicTraffic This property is required. string
TopicTraffic.
MessageHeap This property is required. float64
Topic MessageHeap.
PartitionNum This property is required. float64
PartitionNum.
ReplicaNum This property is required. float64
ReplicaNum.
TopicId This property is required. string
topicId.
TopicName This property is required. string
topicName.
TopicTraffic This property is required. string
TopicTraffic.
messageHeap This property is required. Double
Topic MessageHeap.
partitionNum This property is required. Double
PartitionNum.
replicaNum This property is required. Double
ReplicaNum.
topicId This property is required. String
topicId.
topicName This property is required. String
topicName.
topicTraffic This property is required. String
TopicTraffic.
messageHeap This property is required. number
Topic MessageHeap.
partitionNum This property is required. number
PartitionNum.
replicaNum This property is required. number
ReplicaNum.
topicId This property is required. string
topicId.
topicName This property is required. string
topicName.
topicTraffic This property is required. string
TopicTraffic.
message_heap This property is required. float
Topic MessageHeap.
partition_num This property is required. float
PartitionNum.
replica_num This property is required. float
ReplicaNum.
topic_id This property is required. str
topicId.
topic_name This property is required. str
topicName.
topic_traffic This property is required. str
TopicTraffic.
messageHeap This property is required. Number
Topic MessageHeap.
partitionNum This property is required. Number
PartitionNum.
replicaNum This property is required. Number
ReplicaNum.
topicId This property is required. String
topicId.
topicName This property is required. String
topicName.
topicTraffic This property is required. String
TopicTraffic.

GetCkafkaTopicFlowRankingResultTopicMessageHeap

MessageHeap This property is required. double
Topic MessageHeap.
PartitionNum This property is required. double
PartitionNum.
ReplicaNum This property is required. double
ReplicaNum.
TopicId This property is required. string
topicId.
TopicName This property is required. string
topicName.
TopicTraffic This property is required. string
TopicTraffic.
MessageHeap This property is required. float64
Topic MessageHeap.
PartitionNum This property is required. float64
PartitionNum.
ReplicaNum This property is required. float64
ReplicaNum.
TopicId This property is required. string
topicId.
TopicName This property is required. string
topicName.
TopicTraffic This property is required. string
TopicTraffic.
messageHeap This property is required. Double
Topic MessageHeap.
partitionNum This property is required. Double
PartitionNum.
replicaNum This property is required. Double
ReplicaNum.
topicId This property is required. String
topicId.
topicName This property is required. String
topicName.
topicTraffic This property is required. String
TopicTraffic.
messageHeap This property is required. number
Topic MessageHeap.
partitionNum This property is required. number
PartitionNum.
replicaNum This property is required. number
ReplicaNum.
topicId This property is required. string
topicId.
topicName This property is required. string
topicName.
topicTraffic This property is required. string
TopicTraffic.
message_heap This property is required. float
Topic MessageHeap.
partition_num This property is required. float
PartitionNum.
replica_num This property is required. float
ReplicaNum.
topic_id This property is required. str
topicId.
topic_name This property is required. str
topicName.
topic_traffic This property is required. str
TopicTraffic.
messageHeap This property is required. Number
Topic MessageHeap.
partitionNum This property is required. Number
PartitionNum.
replicaNum This property is required. Number
ReplicaNum.
topicId This property is required. String
topicId.
topicName This property is required. String
topicName.
topicTraffic This property is required. String
TopicTraffic.

Package Details

Repository
tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes
This Pulumi package is based on the tencentcloud Terraform Provider.