getGroup

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 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: 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: 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 创建时间。
Description string: Consumer Group 描述。
GroupId string: Consumer Group 的 ID。
GroupName string: 自定义设置Consumer Group 的名称，约束限制如下：只能由小写英文字符、数字、下划线和中划线（-）组成。长度为 3~64 字符。
Id string: Uniquely identifies the resource.
InstanceId string: 所属 BMQ 实例 ID。
OwnerId string: Consumer Group 所属用户的 ID。
OwnerName string: Consumer Group 所属用户的名称。
ResetInfo Byteplus.GetGroupResetInfo: 重置消费位点信息。
Status string: Consumer Group 的状态。
TopicInfos List<Byteplus.GetGroupTopicInfo>: Topic 列表。

CreatedTime string: Consumer Group 创建时间。
Description string: Consumer Group 描述。
GroupId string: Consumer Group 的 ID。
GroupName string: 自定义设置Consumer Group 的名称，约束限制如下：只能由小写英文字符、数字、下划线和中划线（-）组成。长度为 3~64 字符。
Id string: Uniquely identifies the resource.
InstanceId string: 所属 BMQ 实例 ID。
OwnerId string: Consumer Group 所属用户的 ID。
OwnerName string: Consumer Group 所属用户的名称。
ResetInfo GetGroupResetInfo: 重置消费位点信息。
Status string: Consumer Group 的状态。
TopicInfos []GetGroupTopicInfo: Topic 列表。

createdTime String: Consumer Group 创建时间。
description String: Consumer Group 描述。
groupId String: Consumer Group 的 ID。
groupName String: 自定义设置Consumer Group 的名称，约束限制如下：只能由小写英文字符、数字、下划线和中划线（-）组成。长度为 3~64 字符。
id String: Uniquely identifies the resource.
instanceId String: 所属 BMQ 实例 ID。
ownerId String: Consumer Group 所属用户的 ID。
ownerName String: Consumer Group 所属用户的名称。
resetInfo GetGroupResetInfo: 重置消费位点信息。
status String: Consumer Group 的状态。
topicInfos List<GetGroupTopicInfo>: Topic 列表。

createdTime string: Consumer Group 创建时间。
description string: Consumer Group 描述。
groupId string: Consumer Group 的 ID。
groupName string: 自定义设置Consumer Group 的名称，约束限制如下：只能由小写英文字符、数字、下划线和中划线（-）组成。长度为 3~64 字符。
id string: Uniquely identifies the resource.
instanceId string: 所属 BMQ 实例 ID。
ownerId string: Consumer Group 所属用户的 ID。
ownerName string: Consumer Group 所属用户的名称。
resetInfo GetGroupResetInfo: 重置消费位点信息。
status string: Consumer Group 的状态。
topicInfos GetGroupTopicInfo[]: Topic 列表。

created_time str: Consumer Group 创建时间。
description str: Consumer Group 描述。
group_id str: Consumer Group 的 ID。
group_name str: 自定义设置Consumer Group 的名称，约束限制如下：只能由小写英文字符、数字、下划线和中划线（-）组成。长度为 3~64 字符。
id str: Uniquely identifies the resource.
instance_id str: 所属 BMQ 实例 ID。
owner_id str: Consumer Group 所属用户的 ID。
owner_name str: Consumer Group 所属用户的名称。
reset_info GetGroupResetInfo: 重置消费位点信息。
status str: Consumer Group 的状态。
topic_infos Sequence[GetGroupTopicInfo]: Topic 列表。

createdTime String: Consumer Group 创建时间。
description String: Consumer Group 描述。
groupId String: Consumer Group 的 ID。
groupName String: 自定义设置Consumer Group 的名称，约束限制如下：只能由小写英文字符、数字、下划线和中划线（-）组成。长度为 3~64 字符。
id String: Uniquely identifies the resource.
instanceId String: 所属 BMQ 实例 ID。
ownerId String: Consumer Group 所属用户的 ID。
ownerName String: Consumer Group 所属用户的名称。
resetInfo Property Map: 重置消费位点信息。
status String: Consumer Group 的状态。
topicInfos List<Property Map>: Topic 列表。

Supporting Types

GetGroupResetInfo

OffsetType string: 重置方式为 OFFSET 时，该参数必传，指定重新消费的基准消费位置，取值如下：EARLIEST：基准消费位置为最早消费位点。CURRENT：基准消费位置为当前消费位点。LATEST：基准消费位置为最近消费位点。
PartitionId int: 分区序号。
ResetBy string: 重置方式，取值如下：TIMESTAMP：根据时间点重置消费位点，指定过去或将来的时间点，直接跳转到该时间点的位点开始消费。OFFSET：根据指定的 offset 重置消费位点，即从指定的位点开始消费，可以通过 offsetType 参数指定 offset。
ResetValue int: 重置值。选择重置方式为 TIMESTAMP 时，该值为重新消费的时间点。例如 1722224612000。选择重置方式为 OFFSET 时，该值为相对于 OffsetType 中基准位点的相对偏移量。例如 100。
TopicId string: Topic ID。

OffsetType string: 重置方式为 OFFSET 时，该参数必传，指定重新消费的基准消费位置，取值如下：EARLIEST：基准消费位置为最早消费位点。CURRENT：基准消费位置为当前消费位点。LATEST：基准消费位置为最近消费位点。
PartitionId int: 分区序号。
ResetBy string: 重置方式，取值如下：TIMESTAMP：根据时间点重置消费位点，指定过去或将来的时间点，直接跳转到该时间点的位点开始消费。OFFSET：根据指定的 offset 重置消费位点，即从指定的位点开始消费，可以通过 offsetType 参数指定 offset。
ResetValue int: 重置值。选择重置方式为 TIMESTAMP 时，该值为重新消费的时间点。例如 1722224612000。选择重置方式为 OFFSET 时，该值为相对于 OffsetType 中基准位点的相对偏移量。例如 100。
TopicId string: Topic ID。

offsetType String: 重置方式为 OFFSET 时，该参数必传，指定重新消费的基准消费位置，取值如下：EARLIEST：基准消费位置为最早消费位点。CURRENT：基准消费位置为当前消费位点。LATEST：基准消费位置为最近消费位点。
partitionId Integer: 分区序号。
resetBy String: 重置方式，取值如下：TIMESTAMP：根据时间点重置消费位点，指定过去或将来的时间点，直接跳转到该时间点的位点开始消费。OFFSET：根据指定的 offset 重置消费位点，即从指定的位点开始消费，可以通过 offsetType 参数指定 offset。
resetValue Integer: 重置值。选择重置方式为 TIMESTAMP 时，该值为重新消费的时间点。例如 1722224612000。选择重置方式为 OFFSET 时，该值为相对于 OffsetType 中基准位点的相对偏移量。例如 100。
topicId String: Topic ID。

offsetType string: 重置方式为 OFFSET 时，该参数必传，指定重新消费的基准消费位置，取值如下：EARLIEST：基准消费位置为最早消费位点。CURRENT：基准消费位置为当前消费位点。LATEST：基准消费位置为最近消费位点。
partitionId number: 分区序号。
resetBy string: 重置方式，取值如下：TIMESTAMP：根据时间点重置消费位点，指定过去或将来的时间点，直接跳转到该时间点的位点开始消费。OFFSET：根据指定的 offset 重置消费位点，即从指定的位点开始消费，可以通过 offsetType 参数指定 offset。
resetValue number: 重置值。选择重置方式为 TIMESTAMP 时，该值为重新消费的时间点。例如 1722224612000。选择重置方式为 OFFSET 时，该值为相对于 OffsetType 中基准位点的相对偏移量。例如 100。
topicId string: Topic ID。

offset_type str: 重置方式为 OFFSET 时，该参数必传，指定重新消费的基准消费位置，取值如下：EARLIEST：基准消费位置为最早消费位点。CURRENT：基准消费位置为当前消费位点。LATEST：基准消费位置为最近消费位点。
partition_id int: 分区序号。
reset_by str: 重置方式，取值如下：TIMESTAMP：根据时间点重置消费位点，指定过去或将来的时间点，直接跳转到该时间点的位点开始消费。OFFSET：根据指定的 offset 重置消费位点，即从指定的位点开始消费，可以通过 offsetType 参数指定 offset。
reset_value int: 重置值。选择重置方式为 TIMESTAMP 时，该值为重新消费的时间点。例如 1722224612000。选择重置方式为 OFFSET 时，该值为相对于 OffsetType 中基准位点的相对偏移量。例如 100。
topic_id str: Topic ID。

offsetType String: 重置方式为 OFFSET 时，该参数必传，指定重新消费的基准消费位置，取值如下：EARLIEST：基准消费位置为最早消费位点。CURRENT：基准消费位置为当前消费位点。LATEST：基准消费位置为最近消费位点。
partitionId Number: 分区序号。
resetBy String: 重置方式，取值如下：TIMESTAMP：根据时间点重置消费位点，指定过去或将来的时间点，直接跳转到该时间点的位点开始消费。OFFSET：根据指定的 offset 重置消费位点，即从指定的位点开始消费，可以通过 offsetType 参数指定 offset。
resetValue Number: 重置值。选择重置方式为 TIMESTAMP 时，该值为重新消费的时间点。例如 1722224612000。选择重置方式为 OFFSET 时，该值为相对于 OffsetType 中基准位点的相对偏移量。例如 100。
topicId String: Topic ID。

GetGroupTopicInfo

CreateTime string: Topic 的创建时间。
Description string: Topic 的描述语句。
Lag int: Topic 中未被消费的消息条数。
PartitionInfos List<Byteplus.GetGroupTopicInfoPartitionInfo>: 分区列表。
Partitions int: Topic 分区数。
Retention int: 数据在 Topic 中的保留时长，单位为小时。
Status string: Topic 的状态。
TopicId string: Topic ID。
TopicName string: Topic 的名称。

CreateTime string: Topic 的创建时间。
Description string: Topic 的描述语句。
Lag int: Topic 中未被消费的消息条数。
PartitionInfos []GetGroupTopicInfoPartitionInfo: 分区列表。
Partitions int: Topic 分区数。
Retention int: 数据在 Topic 中的保留时长，单位为小时。
Status string: Topic 的状态。
TopicId string: Topic ID。
TopicName string: Topic 的名称。

createTime String: Topic 的创建时间。
description String: Topic 的描述语句。
lag Integer: Topic 中未被消费的消息条数。
partitionInfos List<GetGroupTopicInfoPartitionInfo>: 分区列表。
partitions Integer: Topic 分区数。
retention Integer: 数据在 Topic 中的保留时长，单位为小时。
status String: Topic 的状态。
topicId String: Topic ID。
topicName String: Topic 的名称。

createTime string: Topic 的创建时间。
description string: Topic 的描述语句。
lag number: Topic 中未被消费的消息条数。
partitionInfos GetGroupTopicInfoPartitionInfo[]: 分区列表。
partitions number: Topic 分区数。
retention number: 数据在 Topic 中的保留时长，单位为小时。
status string: Topic 的状态。
topicId string: Topic ID。
topicName string: Topic 的名称。

create_time str: Topic 的创建时间。
description str: Topic 的描述语句。
lag int: Topic 中未被消费的消息条数。
partition_infos Sequence[GetGroupTopicInfoPartitionInfo]: 分区列表。
partitions int: Topic 分区数。
retention int: 数据在 Topic 中的保留时长，单位为小时。
status str: Topic 的状态。
topic_id str: Topic ID。
topic_name str: Topic 的名称。

createTime String: Topic 的创建时间。
description String: Topic 的描述语句。
lag Number: Topic 中未被消费的消息条数。
partitionInfos List<Property Map>: 分区列表。
partitions Number: Topic 分区数。
retention Number: 数据在 Topic 中的保留时长，单位为小时。
status String: Topic 的状态。
topicId String: Topic ID。
topicName String: Topic 的名称。

GetGroupTopicInfoPartitionInfo

CurrentOffset int: 当前消费位点。
GroupName string: Consumer Group 的名称。
Lag int: 分区中未被消费的消息条数。
LatestOffset int: 最新消费位点。
PartitionId int: 分区序号。
TopicName string: Consumer Group 订阅的 Topic 名称。

CurrentOffset int: 当前消费位点。
GroupName string: Consumer Group 的名称。
Lag int: 分区中未被消费的消息条数。
LatestOffset int: 最新消费位点。
PartitionId int: 分区序号。
TopicName string: Consumer Group 订阅的 Topic 名称。

currentOffset Integer: 当前消费位点。
groupName String: Consumer Group 的名称。
lag Integer: 分区中未被消费的消息条数。
latestOffset Integer: 最新消费位点。
partitionId Integer: 分区序号。
topicName String: Consumer Group 订阅的 Topic 名称。

currentOffset number: 当前消费位点。
groupName string: Consumer Group 的名称。
lag number: 分区中未被消费的消息条数。
latestOffset number: 最新消费位点。
partitionId number: 分区序号。
topicName string: Consumer Group 订阅的 Topic 名称。

current_offset int: 当前消费位点。
group_name str: Consumer Group 的名称。
lag int: 分区中未被消费的消息条数。
latest_offset int: 最新消费位点。
partition_id int: 分区序号。
topic_name str: Consumer Group 订阅的 Topic 名称。

currentOffset Number: 当前消费位点。
groupName String: Consumer Group 的名称。
lag Number: 分区中未被消费的消息条数。
latestOffset Number: 最新消费位点。
partitionId Number: 分区序号。
topicName String: Consumer Group 订阅的 Topic 名称。

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.16
published on Monday, Mar 9, 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