getGroup

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

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: Optional[pulumi.Input[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: volcenginecc: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 a custom Consumer Group name. 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 of the Consumer Group owner
OwnerName string: Name of the Consumer Group owner
ResetInfo Volcengine.GetGroupResetInfo: Reset consumption offset information
Status string: Consumer Group status
TopicInfos List<Volcengine.GetGroupTopicInfo>: Topic list

CreatedTime string: Consumer Group creation time
Description string: Consumer Group description
GroupId string: Consumer Group ID
GroupName string: Set a custom Consumer Group name. 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 of the Consumer Group owner
OwnerName string: Name of the Consumer Group owner
ResetInfo GetGroupResetInfo: Reset consumption offset 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 a custom Consumer Group name. 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 of the Consumer Group owner
ownerName String: Name of the Consumer Group owner
resetInfo GetGroupResetInfo: Reset consumption offset 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 a custom Consumer Group name. 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 of the Consumer Group owner
ownerName string: Name of the Consumer Group owner
resetInfo GetGroupResetInfo: Reset consumption offset 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 a custom Consumer Group name. 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 of the Consumer Group owner
owner_name str: Name of the Consumer Group owner
reset_info GetGroupResetInfo: Reset consumption offset 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 a custom Consumer Group name. 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 of the Consumer Group owner
ownerName String: Name of the Consumer Group owner
resetInfo Property Map: Reset consumption offset information
status String: Consumer Group status
topicInfos List<Property Map>: Topic list

Supporting Types

GetGroupResetInfo

OffsetType string: If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.
PartitionId int: Partition number
ResetBy string: Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.
ResetValue int: Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 100.
TopicId string: Topic ID。

OffsetType string: If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.
PartitionId int: Partition number
ResetBy string: Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.
ResetValue int: Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 100.
TopicId string: Topic ID。

offsetType String: If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.
partitionId Integer: Partition number
resetBy String: Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.
resetValue Integer: Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 100.
topicId String: Topic ID。

offsetType string: If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.
partitionId number: Partition number
resetBy string: Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.
resetValue number: Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 100.
topicId string: Topic ID。

offset_type str: If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.
partition_id int: Partition number
reset_by str: Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.
reset_value int: Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 100.
topic_id str: Topic ID。

offsetType String: If the reset mode is OFFSET, this parameter is required. Specify the reference consumption position for resuming consumption. Options: EARLIEST: Reference position is the earliest offset. CURRENT: Reference position is the current offset. LATEST: Reference position is the latest offset.
partitionId Number: Partition number
resetBy String: Reset mode. Options: TIMESTAMP: Reset the consumption offset based on a timestamp. Specify a past or future time to jump directly to the offset at that time and start consuming. OFFSET: Reset the consumption offset based on a specified offset, starting consumption from that offset. You can specify the offset using the offsetType parameter.
resetValue Number: Reset value. If TIMESTAMP is selected, this value is the timestamp for resuming consumption, e.g., 1722224612000. If OFFSET is selected, this value is the relative offset from the reference offset in OffsetType, e.g., 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<Volcengine.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 offset
GroupName string: Consumer Group name
Lag int: Number of unconsumed messages in the partition
LatestOffset int: Latest consumption offset
PartitionId int: Partition number
TopicName string: Name of the Topic subscribed by the Consumer Group

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

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

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

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

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

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.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