getGroup

bytepluscc v0.0.25, May 7 26

Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getGroup

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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>

def get_group(id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(id: pulumi.Input[Optional[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]

func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

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

public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:bmq/getGroup:getGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getGroup Result

The following output properties are available:

CreatedTime string: Consumer Group creation time.
Description string: Consumer Group description.
GroupId string: Consumer Group ID.
GroupName string: Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
Id string: Uniquely identifies the resource.
InstanceId string: BMQ instance ID.
OwnerId string: User ID associated with the Consumer Group.
OwnerName string: Name of the user associated with the Consumer Group.
ResetInfo Byteplus.GetGroupResetInfo: Reset consumption position information.
Status string: Consumer Group status.
TopicInfos List<Byteplus.GetGroupTopicInfo>: Topic list.

CreatedTime string: Consumer Group creation time.
Description string: Consumer Group description.
GroupId string: Consumer Group ID.
GroupName string: Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
Id string: Uniquely identifies the resource.
InstanceId string: BMQ instance ID.
OwnerId string: User ID associated with the Consumer Group.
OwnerName string: Name of the user associated with the Consumer Group.
ResetInfo GetGroupResetInfo: Reset consumption position information.
Status string: Consumer Group status.
TopicInfos []GetGroupTopicInfo: Topic list.

createdTime String: Consumer Group creation time.
description String: Consumer Group description.
groupId String: Consumer Group ID.
groupName String: Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
id String: Uniquely identifies the resource.
instanceId String: BMQ instance ID.
ownerId String: User ID associated with the Consumer Group.
ownerName String: Name of the user associated with the Consumer Group.
resetInfo GetGroupResetInfo: Reset consumption position information.
status String: Consumer Group status.
topicInfos List<GetGroupTopicInfo>: Topic list.

createdTime string: Consumer Group creation time.
description string: Consumer Group description.
groupId string: Consumer Group ID.
groupName string: Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
id string: Uniquely identifies the resource.
instanceId string: BMQ instance ID.
ownerId string: User ID associated with the Consumer Group.
ownerName string: Name of the user associated with the Consumer Group.
resetInfo GetGroupResetInfo: Reset consumption position information.
status string: Consumer Group status.
topicInfos GetGroupTopicInfo[]: Topic list.

created_time str: Consumer Group creation time.
description str: Consumer Group description.
group_id str: Consumer Group ID.
group_name str: Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
id str: Uniquely identifies the resource.
instance_id str: BMQ instance ID.
owner_id str: User ID associated with the Consumer Group.
owner_name str: Name of the user associated with the Consumer Group.
reset_info GetGroupResetInfo: Reset consumption position information.
status str: Consumer Group status.
topic_infos Sequence[GetGroupTopicInfo]: Topic list.

createdTime String: Consumer Group creation time.
description String: Consumer Group description.
groupId String: Consumer Group ID.
groupName String: Set the Consumer Group name manually. Constraints: Only lowercase English letters, numbers, underscores, and hyphens (-) are allowed. Length must be 3–64 characters.
id String: Uniquely identifies the resource.
instanceId String: BMQ instance ID.
ownerId String: User ID associated with the Consumer Group.
ownerName String: Name of the user associated with the Consumer Group.
resetInfo Property Map: Reset consumption position information.
status String: Consumer Group status.
topicInfos List<Property Map>: Topic list.

Supporting Types

GetGroupResetInfo

OffsetType string: This parameter is required when the reset mode is OFFSET. Specifies the reference consumption position for re-consuming. Options are: EARLIEST: The reference position is the earliest consumption point. CURRENT: The reference position is the current consumption point. LATEST: The reference position is the latest consumption point.
PartitionId int: Partition number.
ResetBy string: Reset mode. Options are: TIMESTAMP: Reset the consumption position based on a specific time point. Specify a past or future time, and jump directly to the position at that time to start consuming. OFFSET: Reset the consumption position based on a specified offset. Start consuming from the specified position, and you can use the offsetType parameter to specify the offset.
ResetValue int: Reset value. If the reset mode is TIMESTAMP, this value is the time point for re-consuming messages, for example, 1722224612000. If the reset mode is OFFSET, this value is the relative offset from the reference position specified in OffsetType, for example, 100.
TopicId string: Topic ID。

OffsetType string: This parameter is required when the reset mode is OFFSET. Specifies the reference consumption position for re-consuming. Options are: EARLIEST: The reference position is the earliest consumption point. CURRENT: The reference position is the current consumption point. LATEST: The reference position is the latest consumption point.
PartitionId int: Partition number.
ResetBy string: Reset mode. Options are: TIMESTAMP: Reset the consumption position based on a specific time point. Specify a past or future time, and jump directly to the position at that time to start consuming. OFFSET: Reset the consumption position based on a specified offset. Start consuming from the specified position, and you can use the offsetType parameter to specify the offset.
ResetValue int: Reset value. If the reset mode is TIMESTAMP, this value is the time point for re-consuming messages, for example, 1722224612000. If the reset mode is OFFSET, this value is the relative offset from the reference position specified in OffsetType, for example, 100.
TopicId string: Topic ID。

offsetType String: This parameter is required when the reset mode is OFFSET. Specifies the reference consumption position for re-consuming. Options are: EARLIEST: The reference position is the earliest consumption point. CURRENT: The reference position is the current consumption point. LATEST: The reference position is the latest consumption point.
partitionId Integer: Partition number.
resetBy String: Reset mode. Options are: TIMESTAMP: Reset the consumption position based on a specific time point. Specify a past or future time, and jump directly to the position at that time to start consuming. OFFSET: Reset the consumption position based on a specified offset. Start consuming from the specified position, and you can use the offsetType parameter to specify the offset.
resetValue Integer: Reset value. If the reset mode is TIMESTAMP, this value is the time point for re-consuming messages, for example, 1722224612000. If the reset mode is OFFSET, this value is the relative offset from the reference position specified in OffsetType, for example, 100.
topicId String: Topic ID。

offsetType string: This parameter is required when the reset mode is OFFSET. Specifies the reference consumption position for re-consuming. Options are: EARLIEST: The reference position is the earliest consumption point. CURRENT: The reference position is the current consumption point. LATEST: The reference position is the latest consumption point.
partitionId number: Partition number.
resetBy string: Reset mode. Options are: TIMESTAMP: Reset the consumption position based on a specific time point. Specify a past or future time, and jump directly to the position at that time to start consuming. OFFSET: Reset the consumption position based on a specified offset. Start consuming from the specified position, and you can use the offsetType parameter to specify the offset.
resetValue number: Reset value. If the reset mode is TIMESTAMP, this value is the time point for re-consuming messages, for example, 1722224612000. If the reset mode is OFFSET, this value is the relative offset from the reference position specified in OffsetType, for example, 100.
topicId string: Topic ID。

offset_type str: This parameter is required when the reset mode is OFFSET. Specifies the reference consumption position for re-consuming. Options are: EARLIEST: The reference position is the earliest consumption point. CURRENT: The reference position is the current consumption point. LATEST: The reference position is the latest consumption point.
partition_id int: Partition number.
reset_by str: Reset mode. Options are: TIMESTAMP: Reset the consumption position based on a specific time point. Specify a past or future time, and jump directly to the position at that time to start consuming. OFFSET: Reset the consumption position based on a specified offset. Start consuming from the specified position, and you can use the offsetType parameter to specify the offset.
reset_value int: Reset value. If the reset mode is TIMESTAMP, this value is the time point for re-consuming messages, for example, 1722224612000. If the reset mode is OFFSET, this value is the relative offset from the reference position specified in OffsetType, for example, 100.
topic_id str: Topic ID。

offsetType String: This parameter is required when the reset mode is OFFSET. Specifies the reference consumption position for re-consuming. Options are: EARLIEST: The reference position is the earliest consumption point. CURRENT: The reference position is the current consumption point. LATEST: The reference position is the latest consumption point.
partitionId Number: Partition number.
resetBy String: Reset mode. Options are: TIMESTAMP: Reset the consumption position based on a specific time point. Specify a past or future time, and jump directly to the position at that time to start consuming. OFFSET: Reset the consumption position based on a specified offset. Start consuming from the specified position, and you can use the offsetType parameter to specify the offset.
resetValue Number: Reset value. If the reset mode is TIMESTAMP, this value is the time point for re-consuming messages, for example, 1722224612000. If the reset mode is OFFSET, this value is the relative offset from the reference position specified in OffsetType, for example, 100.
topicId String: Topic ID。

GetGroupTopicInfo

CreateTime string: Topic creation time.
Description string: Topic description.
Lag int: Number of unconsumed messages in the Topic.
PartitionInfos List<Byteplus.GetGroupTopicInfoPartitionInfo>: Partition list.
Partitions int: Number of Topic partitions.
Retention int: Retention period of data in the Topic, in hours.
Status string: Topic status.
TopicId string: Topic ID。
TopicName string: Topic name.

CreateTime string: Topic creation time.
Description string: Topic description.
Lag int: Number of unconsumed messages in the Topic.
PartitionInfos []GetGroupTopicInfoPartitionInfo: Partition list.
Partitions int: Number of Topic partitions.
Retention int: Retention period of data in the Topic, in hours.
Status string: Topic status.
TopicId string: Topic ID。
TopicName string: Topic name.

createTime String: Topic creation time.
description String: Topic description.
lag Integer: Number of unconsumed messages in the Topic.
partitionInfos List<GetGroupTopicInfoPartitionInfo>: Partition list.
partitions Integer: Number of Topic partitions.
retention Integer: Retention period of data in the Topic, in hours.
status String: Topic status.
topicId String: Topic ID。
topicName String: Topic name.

createTime string: Topic creation time.
description string: Topic description.
lag number: Number of unconsumed messages in the Topic.
partitionInfos GetGroupTopicInfoPartitionInfo[]: Partition list.
partitions number: Number of Topic partitions.
retention number: Retention period of data in the Topic, in hours.
status string: Topic status.
topicId string: Topic ID。
topicName string: Topic name.

create_time str: Topic creation time.
description str: Topic description.
lag int: Number of unconsumed messages in the Topic.
partition_infos Sequence[GetGroupTopicInfoPartitionInfo]: Partition list.
partitions int: Number of Topic partitions.
retention int: Retention period of data in the Topic, in hours.
status str: Topic status.
topic_id str: Topic ID。
topic_name str: Topic name.

createTime String: Topic creation time.
description String: Topic description.
lag Number: Number of unconsumed messages in the Topic.
partitionInfos List<Property Map>: Partition list.
partitions Number: Number of Topic partitions.
retention Number: Retention period of data in the Topic, in hours.
status String: Topic status.
topicId String: Topic ID。
topicName String: Topic name.

GetGroupTopicInfoPartitionInfo

CurrentOffset int: Current consumption position.
GroupName string: Name of the Consumer Group.
Lag int: Number of unconsumed messages in the partition.
LatestOffset int: Latest consumption position.
PartitionId int: Partition number.
TopicName string: Name of the Topic subscribed by the Consumer Group.

CurrentOffset int: Current consumption position.
GroupName string: Name of the Consumer Group.
Lag int: Number of unconsumed messages in the partition.
LatestOffset int: Latest consumption position.
PartitionId int: Partition number.
TopicName string: Name of the Topic subscribed by the Consumer Group.

currentOffset Integer: Current consumption position.
groupName String: Name of the Consumer Group.
lag Integer: Number of unconsumed messages in the partition.
latestOffset Integer: Latest consumption position.
partitionId Integer: Partition number.
topicName String: Name of the Topic subscribed by the Consumer Group.

currentOffset number: Current consumption position.
groupName string: Name of the Consumer Group.
lag number: Number of unconsumed messages in the partition.
latestOffset number: Latest consumption position.
partitionId number: Partition number.
topicName string: Name of the Topic subscribed by the Consumer Group.

current_offset int: Current consumption position.
group_name str: Name of the Consumer Group.
lag int: Number of unconsumed messages in the partition.
latest_offset int: Latest consumption position.
partition_id int: Partition number.
topic_name str: Name of the Topic subscribed by the Consumer Group.

currentOffset Number: Current consumption position.
groupName String: Name of the Consumer Group.
lag Number: Number of unconsumed messages in the partition.
latestOffset Number: Latest consumption position.
partitionId Number: Partition number.
topicName String: Name of the Topic subscribed by the Consumer Group.

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.bmq.getGroup

On this page

On this page

Using getGroup

getGroup Result

Supporting Types

GetGroupResetInfo

GetGroupTopicInfo

GetGroupTopicInfoPartitionInfo

Package Details

On this page

On this page