tencentcloud.getCkafkaTopicSubscribeGroup

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 topicSubscribeGroup = tencentcloud.getCkafkaTopicSubscribeGroup({
    instanceId: "ckafka-xxxxxx",
    topicName: "xxxxxx",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

topic_subscribe_group = tencentcloud.get_ckafka_topic_subscribe_group(instance_id="ckafka-xxxxxx",
    topic_name="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.GetCkafkaTopicSubscribeGroup(ctx, &tencentcloud.GetCkafkaTopicSubscribeGroupArgs{
			InstanceId: "ckafka-xxxxxx",
			TopicName:  "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 topicSubscribeGroup = Tencentcloud.GetCkafkaTopicSubscribeGroup.Invoke(new()
    {
        InstanceId = "ckafka-xxxxxx",
        TopicName = "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.GetCkafkaTopicSubscribeGroupArgs;
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 topicSubscribeGroup = TencentcloudFunctions.getCkafkaTopicSubscribeGroup(GetCkafkaTopicSubscribeGroupArgs.builder()
            .instanceId("ckafka-xxxxxx")
            .topicName("xxxxxx")
            .build());

    }
}

variables:
  topicSubscribeGroup:
    fn::invoke:
      function: tencentcloud:getCkafkaTopicSubscribeGroup
      arguments:
        instanceId: ckafka-xxxxxx
        topicName: xxxxxx

Using getCkafkaTopicSubscribeGroup

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 getCkafkaTopicSubscribeGroup(args: GetCkafkaTopicSubscribeGroupArgs, opts?: InvokeOptions): Promise<GetCkafkaTopicSubscribeGroupResult>
function getCkafkaTopicSubscribeGroupOutput(args: GetCkafkaTopicSubscribeGroupOutputArgs, opts?: InvokeOptions): Output<GetCkafkaTopicSubscribeGroupResult>

def get_ckafka_topic_subscribe_group(id: Optional[str] = None,
                                     instance_id: Optional[str] = None,
                                     result_output_file: Optional[str] = None,
                                     topic_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetCkafkaTopicSubscribeGroupResult
def get_ckafka_topic_subscribe_group_output(id: Optional[pulumi.Input[str]] = None,
                                     instance_id: Optional[pulumi.Input[str]] = None,
                                     result_output_file: Optional[pulumi.Input[str]] = None,
                                     topic_name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetCkafkaTopicSubscribeGroupResult]

func GetCkafkaTopicSubscribeGroup(ctx *Context, args *GetCkafkaTopicSubscribeGroupArgs, opts ...InvokeOption) (*GetCkafkaTopicSubscribeGroupResult, error)
func GetCkafkaTopicSubscribeGroupOutput(ctx *Context, args *GetCkafkaTopicSubscribeGroupOutputArgs, opts ...InvokeOption) GetCkafkaTopicSubscribeGroupResultOutput

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

public static class GetCkafkaTopicSubscribeGroup 
{
    public static Task<GetCkafkaTopicSubscribeGroupResult> InvokeAsync(GetCkafkaTopicSubscribeGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetCkafkaTopicSubscribeGroupResult> Invoke(GetCkafkaTopicSubscribeGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCkafkaTopicSubscribeGroupResult> getCkafkaTopicSubscribeGroup(GetCkafkaTopicSubscribeGroupArgs args, InvokeOptions options)
public static Output<GetCkafkaTopicSubscribeGroupResult> getCkafkaTopicSubscribeGroup(GetCkafkaTopicSubscribeGroupArgs args, InvokeOptions options)

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

The following arguments are supported:

InstanceId string: InstanceId.
TopicName string: TopicName.
Id string
ResultOutputFile string: Used to save results.

InstanceId string: InstanceId.
TopicName string: TopicName.
Id string
ResultOutputFile string: Used to save results.

instanceId String: InstanceId.
topicName String: TopicName.
id String
resultOutputFile String: Used to save results.

instanceId string: InstanceId.
topicName string: TopicName.
id string
resultOutputFile string: Used to save results.

instance_id str: InstanceId.
topic_name str: TopicName.
id str
result_output_file str: Used to save results.

instanceId String: InstanceId.
topicName String: TopicName.
id String
resultOutputFile String: Used to save results.

getCkafkaTopicSubscribeGroup Result

The following output properties are available:

GroupsInfos List<GetCkafkaTopicSubscribeGroupGroupsInfo>: Consumer group information.
Id string
InstanceId string
TopicName string
ResultOutputFile string

GroupsInfos []GetCkafkaTopicSubscribeGroupGroupsInfo: Consumer group information.
Id string
InstanceId string
TopicName string
ResultOutputFile string

groupsInfos List<GetCkafkaTopicSubscribeGroupGroupsInfo>: Consumer group information.
id String
instanceId String
topicName String
resultOutputFile String

groupsInfos GetCkafkaTopicSubscribeGroupGroupsInfo[]: Consumer group information.
id string
instanceId string
topicName string
resultOutputFile string

groups_infos Sequence[GetCkafkaTopicSubscribeGroupGroupsInfo]: Consumer group information.
id str
instance_id str
topic_name str
result_output_file str

groupsInfos List<Property Map>: Consumer group information.
id String
instanceId String
topicName String
resultOutputFile String

Supporting Types

GetCkafkaTopicSubscribeGroupGroupsInfo

ErrorCode string: Error code, normally 0.
Group string: Kafka consumer group.
Members List<GetCkafkaTopicSubscribeGroupGroupsInfoMember>: This array contains information only if state is Stable and protocol_type is consumer.
Protocol string: Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky.
ProtocolType string: The protocol type selected by the consumption group is normally the consumer, but some systems use their own protocol, such as kafka-connect, which uses connect. Only the standard consumer protocol, this interface knows the format of the specific allocation method, and can analyze the specific partition allocation.
State string: Group state description (commonly Empty, Stable, and Dead states): Dead: The consumption group does not exist Empty: The consumption group does not currently have any consumer subscriptions PreparingRebalance: The consumption group is in the rebalance state CompletingRebalance: The consumption group is in the rebalance state Stable: Each consumer in the consumption group has joined and is in a stable state.

ErrorCode string: Error code, normally 0.
Group string: Kafka consumer group.
Members []GetCkafkaTopicSubscribeGroupGroupsInfoMember: This array contains information only if state is Stable and protocol_type is consumer.
Protocol string: Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky.
ProtocolType string: The protocol type selected by the consumption group is normally the consumer, but some systems use their own protocol, such as kafka-connect, which uses connect. Only the standard consumer protocol, this interface knows the format of the specific allocation method, and can analyze the specific partition allocation.
State string: Group state description (commonly Empty, Stable, and Dead states): Dead: The consumption group does not exist Empty: The consumption group does not currently have any consumer subscriptions PreparingRebalance: The consumption group is in the rebalance state CompletingRebalance: The consumption group is in the rebalance state Stable: Each consumer in the consumption group has joined and is in a stable state.

errorCode String: Error code, normally 0.
group String: Kafka consumer group.
members List<GetCkafkaTopicSubscribeGroupGroupsInfoMember>: This array contains information only if state is Stable and protocol_type is consumer.
protocol String: Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky.
protocolType String: The protocol type selected by the consumption group is normally the consumer, but some systems use their own protocol, such as kafka-connect, which uses connect. Only the standard consumer protocol, this interface knows the format of the specific allocation method, and can analyze the specific partition allocation.
state String: Group state description (commonly Empty, Stable, and Dead states): Dead: The consumption group does not exist Empty: The consumption group does not currently have any consumer subscriptions PreparingRebalance: The consumption group is in the rebalance state CompletingRebalance: The consumption group is in the rebalance state Stable: Each consumer in the consumption group has joined and is in a stable state.

errorCode string: Error code, normally 0.
group string: Kafka consumer group.
members GetCkafkaTopicSubscribeGroupGroupsInfoMember[]: This array contains information only if state is Stable and protocol_type is consumer.
protocol string: Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky.
protocolType string: The protocol type selected by the consumption group is normally the consumer, but some systems use their own protocol, such as kafka-connect, which uses connect. Only the standard consumer protocol, this interface knows the format of the specific allocation method, and can analyze the specific partition allocation.
state string: Group state description (commonly Empty, Stable, and Dead states): Dead: The consumption group does not exist Empty: The consumption group does not currently have any consumer subscriptions PreparingRebalance: The consumption group is in the rebalance state CompletingRebalance: The consumption group is in the rebalance state Stable: Each consumer in the consumption group has joined and is in a stable state.

error_code str: Error code, normally 0.
group str: Kafka consumer group.
members Sequence[GetCkafkaTopicSubscribeGroupGroupsInfoMember]: This array contains information only if state is Stable and protocol_type is consumer.
protocol str: Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky.
protocol_type str: The protocol type selected by the consumption group is normally the consumer, but some systems use their own protocol, such as kafka-connect, which uses connect. Only the standard consumer protocol, this interface knows the format of the specific allocation method, and can analyze the specific partition allocation.
state str: Group state description (commonly Empty, Stable, and Dead states): Dead: The consumption group does not exist Empty: The consumption group does not currently have any consumer subscriptions PreparingRebalance: The consumption group is in the rebalance state CompletingRebalance: The consumption group is in the rebalance state Stable: Each consumer in the consumption group has joined and is in a stable state.

errorCode String: Error code, normally 0.
group String: Kafka consumer group.
members List<Property Map>: This array contains information only if state is Stable and protocol_type is consumer.
protocol String: Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky.
protocolType String: The protocol type selected by the consumption group is normally the consumer, but some systems use their own protocol, such as kafka-connect, which uses connect. Only the standard consumer protocol, this interface knows the format of the specific allocation method, and can analyze the specific partition allocation.
state String: Group state description (commonly Empty, Stable, and Dead states): Dead: The consumption group does not exist Empty: The consumption group does not currently have any consumer subscriptions PreparingRebalance: The consumption group is in the rebalance state CompletingRebalance: The consumption group is in the rebalance state Stable: Each consumer in the consumption group has joined and is in a stable state.

GetCkafkaTopicSubscribeGroupGroupsInfoMember

Assignments List<GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignment>: Stores the partition information assigned to the consumer.
ClientHost string: Generally store the customer's IP address.
ClientId string: The client.id information set by the client consumer SDK itself.
MemberId string: ID that the coordinator generated for consumer.

Assignments []GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignment: Stores the partition information assigned to the consumer.
ClientHost string: Generally store the customer's IP address.
ClientId string: The client.id information set by the client consumer SDK itself.
MemberId string: ID that the coordinator generated for consumer.

assignments List<GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignment>: Stores the partition information assigned to the consumer.
clientHost String: Generally store the customer's IP address.
clientId String: The client.id information set by the client consumer SDK itself.
memberId String: ID that the coordinator generated for consumer.

assignments GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignment[]: Stores the partition information assigned to the consumer.
clientHost string: Generally store the customer's IP address.
clientId string: The client.id information set by the client consumer SDK itself.
memberId string: ID that the coordinator generated for consumer.

assignments Sequence[GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignment]: Stores the partition information assigned to the consumer.
client_host str: Generally store the customer's IP address.
client_id str: The client.id information set by the client consumer SDK itself.
member_id str: ID that the coordinator generated for consumer.

assignments List<Property Map>: Stores the partition information assigned to the consumer.
clientHost String: Generally store the customer's IP address.
clientId String: The client.id information set by the client consumer SDK itself.
memberId String: ID that the coordinator generated for consumer.