tencentcloud.getCkafkaGroupInfo

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 groupInfo = tencentcloud.getCkafkaGroupInfo({
    groupLists: ["xxxxxx"],
    instanceId: "ckafka-xxxxxx",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

group_info = tencentcloud.get_ckafka_group_info(group_lists=["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.LookupCkafkaGroupInfo(ctx, &tencentcloud.LookupCkafkaGroupInfoArgs{
			GroupLists: []string{
				"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 groupInfo = Tencentcloud.GetCkafkaGroupInfo.Invoke(new()
    {
        GroupLists = new[]
        {
            "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.GetCkafkaGroupInfoArgs;
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 groupInfo = TencentcloudFunctions.getCkafkaGroupInfo(GetCkafkaGroupInfoArgs.builder()
            .groupLists("xxxxxx")
            .instanceId("ckafka-xxxxxx")
            .build());

    }
}

variables:
  groupInfo:
    fn::invoke:
      function: tencentcloud:getCkafkaGroupInfo
      arguments:
        groupLists:
          - xxxxxx
        instanceId: ckafka-xxxxxx

Using getCkafkaGroupInfo

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 getCkafkaGroupInfo(args: GetCkafkaGroupInfoArgs, opts?: InvokeOptions): Promise<GetCkafkaGroupInfoResult>
function getCkafkaGroupInfoOutput(args: GetCkafkaGroupInfoOutputArgs, opts?: InvokeOptions): Output<GetCkafkaGroupInfoResult>

def get_ckafka_group_info(group_lists: Optional[Sequence[str]] = None,
                          id: Optional[str] = None,
                          instance_id: Optional[str] = None,
                          result_output_file: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCkafkaGroupInfoResult
def get_ckafka_group_info_output(group_lists: Optional[pulumi.Input[Sequence[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,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCkafkaGroupInfoResult]

func LookupCkafkaGroupInfo(ctx *Context, args *LookupCkafkaGroupInfoArgs, opts ...InvokeOption) (*LookupCkafkaGroupInfoResult, error)
func LookupCkafkaGroupInfoOutput(ctx *Context, args *LookupCkafkaGroupInfoOutputArgs, opts ...InvokeOption) LookupCkafkaGroupInfoResultOutput

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

public static class GetCkafkaGroupInfo 
{
    public static Task<GetCkafkaGroupInfoResult> InvokeAsync(GetCkafkaGroupInfoArgs args, InvokeOptions? opts = null)
    public static Output<GetCkafkaGroupInfoResult> Invoke(GetCkafkaGroupInfoInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCkafkaGroupInfoResult> getCkafkaGroupInfo(GetCkafkaGroupInfoArgs args, InvokeOptions options)
public static Output<GetCkafkaGroupInfoResult> getCkafkaGroupInfo(GetCkafkaGroupInfoArgs args, InvokeOptions options)

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

The following arguments are supported:

GroupLists List<string>: Kafka consumption group, Consumer-group, here is an array format, format GroupList.0=xxx&GroupList.1=yyy.
InstanceId string: InstanceId.
Id string
ResultOutputFile string: Used to save results.

GroupLists []string: Kafka consumption group, Consumer-group, here is an array format, format GroupList.0=xxx&GroupList.1=yyy.
InstanceId string: InstanceId.
Id string
ResultOutputFile string: Used to save results.

groupLists List<String>: Kafka consumption group, Consumer-group, here is an array format, format GroupList.0=xxx&GroupList.1=yyy.
instanceId String: InstanceId.
id String
resultOutputFile String: Used to save results.

groupLists string[]: Kafka consumption group, Consumer-group, here is an array format, format GroupList.0=xxx&GroupList.1=yyy.
instanceId string: InstanceId.
id string
resultOutputFile string: Used to save results.

group_lists Sequence[str]: Kafka consumption group, Consumer-group, here is an array format, format GroupList.0=xxx&GroupList.1=yyy.
instance_id str: InstanceId.
id str
result_output_file str: Used to save results.

groupLists List<String>: Kafka consumption group, Consumer-group, here is an array format, format GroupList.0=xxx&GroupList.1=yyy.
instanceId String: InstanceId.
id String
resultOutputFile String: Used to save results.

getCkafkaGroupInfo Result

The following output properties are available:

GroupLists List<string>
Id string
InstanceId string
Results List<GetCkafkaGroupInfoResult>: result.
ResultOutputFile string

GroupLists []string
Id string
InstanceId string
Results []GetCkafkaGroupInfoResult: result.
ResultOutputFile string

groupLists List<String>
id String
instanceId String
results List<GetCkafkaGroupInfoResult>: result.
resultOutputFile String

groupLists string[]
id string
instanceId string
results GetCkafkaGroupInfoResult[]: result.
resultOutputFile string

group_lists Sequence[str]
id str
instance_id str
results Sequence[GetCkafkaGroupInfoResult]: result.
result_output_file str

groupLists List<String>
id String
instanceId String
results List<Property Map>: result.
resultOutputFile String

Supporting Types

GetCkafkaGroupInfoResult

ErrorCode string: Error code, normally 0.
Group string: Kafka consumer group.
Members List<GetCkafkaGroupInfoResultMember>: 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 []GetCkafkaGroupInfoResultMember: 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<GetCkafkaGroupInfoResultMember>: 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 GetCkafkaGroupInfoResultMember[]: 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[GetCkafkaGroupInfoResultMember]: 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.

GetCkafkaGroupInfoResultMember

Assignments List<GetCkafkaGroupInfoResultMemberAssignment>: 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 []GetCkafkaGroupInfoResultMemberAssignment: 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<GetCkafkaGroupInfoResultMemberAssignment>: 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 GetCkafkaGroupInfoResultMemberAssignment[]: 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[GetCkafkaGroupInfoResultMemberAssignment]: 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.