tencentcloud 1.81.189, Apr 30 25

tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getCkafkaGroupOffsets

Explore with Pulumi AI

tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

Example Usage

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

const groupOffsets = tencentcloud.getCkafkaGroupOffsets({
    group: "xxxxxx",
    instanceId: "ckafka-xxxxxx",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

group_offsets = tencentcloud.get_ckafka_group_offsets(group="xxxxxx",
    instance_id="ckafka-xxxxxx")

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.GetCkafkaGroupOffsets(ctx, &tencentcloud.GetCkafkaGroupOffsetsArgs{
			Group:      "xxxxxx",
			InstanceId: "ckafka-xxxxxx",
		}, 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 groupOffsets = Tencentcloud.GetCkafkaGroupOffsets.Invoke(new()
    {
        Group = "xxxxxx",
        InstanceId = "ckafka-xxxxxx",
    });

});

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.GetCkafkaGroupOffsetsArgs;
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 groupOffsets = TencentcloudFunctions.getCkafkaGroupOffsets(GetCkafkaGroupOffsetsArgs.builder()
            .group("xxxxxx")
            .instanceId("ckafka-xxxxxx")
            .build());

    }
}

variables:
  groupOffsets:
    fn::invoke:
      function: tencentcloud:getCkafkaGroupOffsets
      arguments:
        group: xxxxxx
        instanceId: ckafka-xxxxxx

Using getCkafkaGroupOffsets

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 getCkafkaGroupOffsets(args: GetCkafkaGroupOffsetsArgs, opts?: InvokeOptions): Promise<GetCkafkaGroupOffsetsResult>
function getCkafkaGroupOffsetsOutput(args: GetCkafkaGroupOffsetsOutputArgs, opts?: InvokeOptions): Output<GetCkafkaGroupOffsetsResult>

def get_ckafka_group_offsets(group: Optional[str] = None,
                             id: Optional[str] = None,
                             instance_id: Optional[str] = None,
                             result_output_file: Optional[str] = None,
                             search_word: Optional[str] = None,
                             topics: Optional[Sequence[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCkafkaGroupOffsetsResult
def get_ckafka_group_offsets_output(group: Optional[pulumi.Input[str]] = None,
                             id: Optional[pulumi.Input[str]] = None,
                             instance_id: Optional[pulumi.Input[str]] = None,
                             result_output_file: Optional[pulumi.Input[str]] = None,
                             search_word: Optional[pulumi.Input[str]] = None,
                             topics: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCkafkaGroupOffsetsResult]

func GetCkafkaGroupOffsets(ctx *Context, args *GetCkafkaGroupOffsetsArgs, opts ...InvokeOption) (*GetCkafkaGroupOffsetsResult, error)
func GetCkafkaGroupOffsetsOutput(ctx *Context, args *GetCkafkaGroupOffsetsOutputArgs, opts ...InvokeOption) GetCkafkaGroupOffsetsResultOutput

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

public static class GetCkafkaGroupOffsets 
{
    public static Task<GetCkafkaGroupOffsetsResult> InvokeAsync(GetCkafkaGroupOffsetsArgs args, InvokeOptions? opts = null)
    public static Output<GetCkafkaGroupOffsetsResult> Invoke(GetCkafkaGroupOffsetsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCkafkaGroupOffsetsResult> getCkafkaGroupOffsets(GetCkafkaGroupOffsetsArgs args, InvokeOptions options)
public static Output<GetCkafkaGroupOffsetsResult> getCkafkaGroupOffsets(GetCkafkaGroupOffsetsArgs args, InvokeOptions options)

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

The following arguments are supported:

Group string: Kafka consumer group name.
InstanceId string: InstanceId.
Id string
ResultOutputFile string: Used to save results.
SearchWord string: fuzzy match topicName.
Topics List<string>: An array of topic names subscribed by the group, if there is no such array, it means all topic information under the specified group.

Group string: Kafka consumer group name.
InstanceId string: InstanceId.
Id string
ResultOutputFile string: Used to save results.
SearchWord string: fuzzy match topicName.
Topics []string: An array of topic names subscribed by the group, if there is no such array, it means all topic information under the specified group.

group String: Kafka consumer group name.
instanceId String: InstanceId.
id String
resultOutputFile String: Used to save results.
searchWord String: fuzzy match topicName.
topics List<String>: An array of topic names subscribed by the group, if there is no such array, it means all topic information under the specified group.

group string: Kafka consumer group name.
instanceId string: InstanceId.
id string
resultOutputFile string: Used to save results.
searchWord string: fuzzy match topicName.
topics string[]: An array of topic names subscribed by the group, if there is no such array, it means all topic information under the specified group.

group str: Kafka consumer group name.
instance_id str: InstanceId.
id str
result_output_file str: Used to save results.
search_word str: fuzzy match topicName.
topics Sequence[str]: An array of topic names subscribed by the group, if there is no such array, it means all topic information under the specified group.

group String: Kafka consumer group name.
instanceId String: InstanceId.
id String
resultOutputFile String: Used to save results.
searchWord String: fuzzy match topicName.
topics List<String>: An array of topic names subscribed by the group, if there is no such array, it means all topic information under the specified group.

getCkafkaGroupOffsets Result

The following output properties are available:

Group string
Id string
InstanceId string
TopicLists List<GetCkafkaGroupOffsetsTopicList>: The topic array, where each element is a json object.
ResultOutputFile string
SearchWord string
Topics List<string>

Group string
Id string
InstanceId string
TopicLists []GetCkafkaGroupOffsetsTopicList: The topic array, where each element is a json object.
ResultOutputFile string
SearchWord string
Topics []string

group String
id String
instanceId String
topicLists List<GetCkafkaGroupOffsetsTopicList>: The topic array, where each element is a json object.
resultOutputFile String
searchWord String
topics List<String>

group string
id string
instanceId string
topicLists GetCkafkaGroupOffsetsTopicList[]: The topic array, where each element is a json object.
resultOutputFile string
searchWord string
topics string[]

group str
id str
instance_id str
topic_lists Sequence[GetCkafkaGroupOffsetsTopicList]: The topic array, where each element is a json object.
result_output_file str
search_word str
topics Sequence[str]

group String
id String
instanceId String
topicLists List<Property Map>: The topic array, where each element is a json object.
resultOutputFile String
searchWord String
topics List<String>

Supporting Types

GetCkafkaGroupOffsetsTopicList

Partitions List<GetCkafkaGroupOffsetsTopicListPartition>: he topic partition array, where each element is a json object.
Topic string: topicName.

Partitions []GetCkafkaGroupOffsetsTopicListPartition: he topic partition array, where each element is a json object.
Topic string: topicName.

partitions List<GetCkafkaGroupOffsetsTopicListPartition>: he topic partition array, where each element is a json object.
topic String: topicName.

partitions GetCkafkaGroupOffsetsTopicListPartition[]: he topic partition array, where each element is a json object.
topic string: topicName.

partitions Sequence[GetCkafkaGroupOffsetsTopicListPartition]: he topic partition array, where each element is a json object.
topic str: topicName.

partitions List<Property Map>: he topic partition array, where each element is a json object.
topic String: topicName.

GetCkafkaGroupOffsetsTopicListPartition

ErrorCode double: ErrorCode.
Lag double: The number of unconsumed messages.
LogEndOffset double: The latest offset of the current partition.
Metadata string: When consumers submit messages, they can pass in metadata for other purposes. Currently, it is usually an empty string.
Offset double: The offset of the position.
Partition double: topic partitionId.

ErrorCode float64: ErrorCode.
Lag float64: The number of unconsumed messages.
LogEndOffset float64: The latest offset of the current partition.
Metadata string: When consumers submit messages, they can pass in metadata for other purposes. Currently, it is usually an empty string.
Offset float64: The offset of the position.
Partition float64: topic partitionId.

errorCode Double: ErrorCode.
lag Double: The number of unconsumed messages.
logEndOffset Double: The latest offset of the current partition.
metadata String: When consumers submit messages, they can pass in metadata for other purposes. Currently, it is usually an empty string.
offset Double: The offset of the position.
partition Double: topic partitionId.

errorCode number: ErrorCode.
lag number: The number of unconsumed messages.
logEndOffset number: The latest offset of the current partition.
metadata string: When consumers submit messages, they can pass in metadata for other purposes. Currently, it is usually an empty string.
offset number: The offset of the position.
partition number: topic partitionId.

error_code float: ErrorCode.
lag float: The number of unconsumed messages.
log_end_offset float: The latest offset of the current partition.
metadata str: When consumers submit messages, they can pass in metadata for other purposes. Currently, it is usually an empty string.
offset float: The offset of the position.
partition float: topic partitionId.

errorCode Number: ErrorCode.
lag Number: The number of unconsumed messages.
logEndOffset Number: The latest offset of the current partition.
metadata String: When consumers submit messages, they can pass in metadata for other purposes. Currently, it is usually an empty string.
offset Number: The offset of the position.
partition Number: topic partitionId.

Package Details

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

tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getCkafkaGroupOffsets

On this page

On this page

Example Usage

Using getCkafkaGroupOffsets

getCkafkaGroupOffsets Result

Supporting Types

GetCkafkaGroupOffsetsTopicList

GetCkafkaGroupOffsetsTopicListPartition

Package Details

On this page

On this page