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

tencentcloud.getCkafkaTopicSubscribeGroup

Explore with Pulumi AI

Use this data source to query detailed information of ckafka topic_subscribe_group

Example Usage

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

const topicSubscribeGroup = tencentcloud.getCkafkaTopicSubscribeGroup({
    instanceId: "ckafka-xxxxxx",
    topicName: "xxxxxx",
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

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

});
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.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());

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

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>
Copy
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]
Copy
func GetCkafkaTopicSubscribeGroup(ctx *Context, args *GetCkafkaTopicSubscribeGroupArgs, opts ...InvokeOption) (*GetCkafkaTopicSubscribeGroupResult, error)
func GetCkafkaTopicSubscribeGroupOutput(ctx *Context, args *GetCkafkaTopicSubscribeGroupOutputArgs, opts ...InvokeOption) GetCkafkaTopicSubscribeGroupResultOutput
Copy

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

The following arguments are supported:

InstanceId This property is required. string
InstanceId.
TopicName This property is required. string
TopicName.
Id string
ResultOutputFile string
Used to save results.
InstanceId This property is required. string
InstanceId.
TopicName This property is required. string
TopicName.
Id string
ResultOutputFile string
Used to save results.
instanceId This property is required. String
InstanceId.
topicName This property is required. String
TopicName.
id String
resultOutputFile String
Used to save results.
instanceId This property is required. string
InstanceId.
topicName This property is required. string
TopicName.
id string
resultOutputFile string
Used to save results.
instance_id This property is required. str
InstanceId.
topic_name This property is required. str
TopicName.
id str
result_output_file str
Used to save results.
instanceId This property is required. String
InstanceId.
topicName This property is required. String
TopicName.
id String
resultOutputFile String
Used to save results.

getCkafkaTopicSubscribeGroup Result

The following output properties are available:

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

Supporting Types

GetCkafkaTopicSubscribeGroupGroupsInfo

ErrorCode This property is required. string
Error code, normally 0.
Group This property is required. string
Kafka consumer group.
Members This property is required. List<GetCkafkaTopicSubscribeGroupGroupsInfoMember>
This array contains information only if state is Stable and protocol_type is consumer.
Protocol This property is required. string
Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky.
ProtocolType This property is required. 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 This property is required. 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 This property is required. string
Error code, normally 0.
Group This property is required. string
Kafka consumer group.
Members This property is required. []GetCkafkaTopicSubscribeGroupGroupsInfoMember
This array contains information only if state is Stable and protocol_type is consumer.
Protocol This property is required. string
Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky.
ProtocolType This property is required. 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 This property is required. 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 This property is required. String
Error code, normally 0.
group This property is required. String
Kafka consumer group.
members This property is required. List<GetCkafkaTopicSubscribeGroupGroupsInfoMember>
This array contains information only if state is Stable and protocol_type is consumer.
protocol This property is required. String
Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky.
protocolType This property is required. 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 This property is required. 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 This property is required. string
Error code, normally 0.
group This property is required. string
Kafka consumer group.
members This property is required. GetCkafkaTopicSubscribeGroupGroupsInfoMember[]
This array contains information only if state is Stable and protocol_type is consumer.
protocol This property is required. string
Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky.
protocolType This property is required. 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 This property is required. 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 This property is required. str
Error code, normally 0.
group This property is required. str
Kafka consumer group.
members This property is required. Sequence[GetCkafkaTopicSubscribeGroupGroupsInfoMember]
This array contains information only if state is Stable and protocol_type is consumer.
protocol This property is required. str
Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky.
protocol_type This property is required. 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 This property is required. 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 This property is required. String
Error code, normally 0.
group This property is required. String
Kafka consumer group.
members This property is required. List<Property Map>
This array contains information only if state is Stable and protocol_type is consumer.
protocol This property is required. String
Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky.
protocolType This property is required. 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 This property is required. 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 This property is required. List<GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignment>
Stores the partition information assigned to the consumer.
ClientHost This property is required. string
Generally store the customer's IP address.
ClientId This property is required. string
The client.id information set by the client consumer SDK itself.
MemberId This property is required. string
ID that the coordinator generated for consumer.
Assignments This property is required. []GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignment
Stores the partition information assigned to the consumer.
ClientHost This property is required. string
Generally store the customer's IP address.
ClientId This property is required. string
The client.id information set by the client consumer SDK itself.
MemberId This property is required. string
ID that the coordinator generated for consumer.
assignments This property is required. List<GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignment>
Stores the partition information assigned to the consumer.
clientHost This property is required. String
Generally store the customer's IP address.
clientId This property is required. String
The client.id information set by the client consumer SDK itself.
memberId This property is required. String
ID that the coordinator generated for consumer.
assignments This property is required. GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignment[]
Stores the partition information assigned to the consumer.
clientHost This property is required. string
Generally store the customer's IP address.
clientId This property is required. string
The client.id information set by the client consumer SDK itself.
memberId This property is required. string
ID that the coordinator generated for consumer.
assignments This property is required. Sequence[GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignment]
Stores the partition information assigned to the consumer.
client_host This property is required. str
Generally store the customer's IP address.
client_id This property is required. str
The client.id information set by the client consumer SDK itself.
member_id This property is required. str
ID that the coordinator generated for consumer.
assignments This property is required. List<Property Map>
Stores the partition information assigned to the consumer.
clientHost This property is required. String
Generally store the customer's IP address.
clientId This property is required. String
The client.id information set by the client consumer SDK itself.
memberId This property is required. String
ID that the coordinator generated for consumer.

GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignment

Topics This property is required. List<GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignmentTopic>
topic list.
Version This property is required. double
assignment version information.
Topics This property is required. []GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignmentTopic
topic list.
Version This property is required. float64
assignment version information.
topics This property is required. List<GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignmentTopic>
topic list.
version This property is required. Double
assignment version information.
topics This property is required. GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignmentTopic[]
topic list.
version This property is required. number
assignment version information.
topics This property is required. Sequence[GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignmentTopic]
topic list.
version This property is required. float
assignment version information.
topics This property is required. List<Property Map>
topic list.
version This property is required. Number
assignment version information.

GetCkafkaTopicSubscribeGroupGroupsInfoMemberAssignmentTopic

Partitions This property is required. List<double>
partition list.
Topic This property is required. string
topic name.
Partitions This property is required. []float64
partition list.
Topic This property is required. string
topic name.
partitions This property is required. List<Double>
partition list.
topic This property is required. String
topic name.
partitions This property is required. number[]
partition list.
topic This property is required. string
topic name.
partitions This property is required. Sequence[float]
partition list.
topic This property is required. str
topic name.
partitions This property is required. List<Number>
partition list.
topic This property is required. String
topic name.

Package Details

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