volcenginecc.rocketmq.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:rocketmq/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:

ConsumeMessageOrderly bool: Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
ConsumedClients List<Volcengine.GetGroupConsumedClient>: Consumer client list.
ConsumedTopics List<Volcengine.GetGroupConsumedTopic>: Topic information subscribed by consumer instance groups under this Group.
CreatedTime string: Group creation time.
Description string: Brief description of the Group.
GroupId string: Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
GroupType string: Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
Id string: Uniquely identifies the resource.
InstanceId string: Instance ID.
IsSubSame bool: Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
LastUpdateTimestamp string: Whether consumption is sequential.
MessageDelayTime string: Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
MessageModel string: Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
RetryMaxTimes int: Maximum number of consumption retries.
RocketmqVersion string: RocketMQ version.
ServiceStatus string: Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
Status string: Consumer group status. Online: Consuming, Offline: Not consuming.
TotalConsumedRate string: Total TPS of consumer instance groups under this Group, measured in messages per second.
TotalDiff int: Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.

ConsumeMessageOrderly bool: Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
ConsumedClients []GetGroupConsumedClient: Consumer client list.
ConsumedTopics []GetGroupConsumedTopic: Topic information subscribed by consumer instance groups under this Group.
CreatedTime string: Group creation time.
Description string: Brief description of the Group.
GroupId string: Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
GroupType string: Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
Id string: Uniquely identifies the resource.
InstanceId string: Instance ID.
IsSubSame bool: Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
LastUpdateTimestamp string: Whether consumption is sequential.
MessageDelayTime string: Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
MessageModel string: Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
RetryMaxTimes int: Maximum number of consumption retries.
RocketmqVersion string: RocketMQ version.
ServiceStatus string: Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
Status string: Consumer group status. Online: Consuming, Offline: Not consuming.
TotalConsumedRate string: Total TPS of consumer instance groups under this Group, measured in messages per second.
TotalDiff int: Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.

consumeMessageOrderly Boolean: Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
consumedClients List<GetGroupConsumedClient>: Consumer client list.
consumedTopics List<GetGroupConsumedTopic>: Topic information subscribed by consumer instance groups under this Group.
createdTime String: Group creation time.
description String: Brief description of the Group.
groupId String: Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
groupType String: Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
id String: Uniquely identifies the resource.
instanceId String: Instance ID.
isSubSame Boolean: Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
lastUpdateTimestamp String: Whether consumption is sequential.
messageDelayTime String: Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
messageModel String: Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
retryMaxTimes Integer: Maximum number of consumption retries.
rocketmqVersion String: RocketMQ version.
serviceStatus String: Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
status String: Consumer group status. Online: Consuming, Offline: Not consuming.
totalConsumedRate String: Total TPS of consumer instance groups under this Group, measured in messages per second.
totalDiff Integer: Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.

consumeMessageOrderly boolean: Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
consumedClients GetGroupConsumedClient[]: Consumer client list.
consumedTopics GetGroupConsumedTopic[]: Topic information subscribed by consumer instance groups under this Group.
createdTime string: Group creation time.
description string: Brief description of the Group.
groupId string: Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
groupType string: Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
id string: Uniquely identifies the resource.
instanceId string: Instance ID.
isSubSame boolean: Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
lastUpdateTimestamp string: Whether consumption is sequential.
messageDelayTime string: Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
messageModel string: Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
retryMaxTimes number: Maximum number of consumption retries.
rocketmqVersion string: RocketMQ version.
serviceStatus string: Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
status string: Consumer group status. Online: Consuming, Offline: Not consuming.
totalConsumedRate string: Total TPS of consumer instance groups under this Group, measured in messages per second.
totalDiff number: Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.

consume_message_orderly bool: Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
consumed_clients Sequence[GetGroupConsumedClient]: Consumer client list.
consumed_topics Sequence[GetGroupConsumedTopic]: Topic information subscribed by consumer instance groups under this Group.
created_time str: Group creation time.
description str: Brief description of the Group.
group_id str: Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
group_type str: Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
id str: Uniquely identifies the resource.
instance_id str: Instance ID.
is_sub_same bool: Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
last_update_timestamp str: Whether consumption is sequential.
message_delay_time str: Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
message_model str: Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
retry_max_times int: Maximum number of consumption retries.
rocketmq_version str: RocketMQ version.
service_status str: Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
status str: Consumer group status. Online: Consuming, Offline: Not consuming.
total_consumed_rate str: Total TPS of consumer instance groups under this Group, measured in messages per second.
total_diff int: Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.

consumeMessageOrderly Boolean: Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
consumedClients List<Property Map>: Consumer client list.
consumedTopics List<Property Map>: Topic information subscribed by consumer instance groups under this Group.
createdTime String: Group creation time.
description String: Brief description of the Group.
groupId String: Group ID. Length must be between 7 and 120 characters and can only contain letters, numbers, hyphens (-), and underscores (). It is recommended to start with GID - or GID. The ID cannot be changed after the Group is created, so set it carefully. For RocketMQ instances created on or before June 5, 2023, the Group name cannot exceed 93 characters.
groupType String: Group protocol identifier, used to indicate the production and consumption protocol type for this Group. Can be set to TCP.
id String: Uniquely identifies the resource.
instanceId String: Instance ID.
isSubSame Boolean: Whether the subscription relationships of consumer instance groups within the Group are consistent. true: Consistent, false: Inconsistent.
lastUpdateTimestamp String: Whether consumption is sequential.
messageDelayTime String: Message latency. The difference between the production time of the earliest unconsumed message in the consumer instance group and the current time, measured in milliseconds.
messageModel String: Message consumption mode. The default is clustering mode. Do not configure both clustering and broadcasting modes under the same Group. Clustering: Clustering consumption mode, Broadcasting: Broadcasting consumption mode.
retryMaxTimes Number: Maximum number of consumption retries.
rocketmqVersion String: RocketMQ version.
serviceStatus String: Service status. Creating: Being created, Running: Running, Deleting: Being deleted, Abnormal: Abnormal, Updating: Being updated.
status String: Consumer group status. Online: Consuming, Offline: Not consuming.
totalConsumedRate String: Total TPS of consumer instance groups under this Group, measured in messages per second.
totalDiff Number: Total number of unconsumed messages in the consumer instance group. The message backlog shown here is the total backlog before Tag filtering, including messages for all Tags under the Topic.

Supporting Types

GetGroupConsumedClient

ClientAddress string: Address and port of this consumer instance.
ClientId string: ID of this consumer instance.
Diff int: Message backlog.
Language string: Development language of the consumer application.
Version string: Consumer version.

ClientAddress string: Address and port of this consumer instance.
ClientId string: ID of this consumer instance.
Diff int: Message backlog.
Language string: Development language of the consumer application.
Version string: Consumer version.

clientAddress String: Address and port of this consumer instance.
clientId String: ID of this consumer instance.
diff Integer: Message backlog.
language String: Development language of the consumer application.
version String: Consumer version.

clientAddress string: Address and port of this consumer instance.
clientId string: ID of this consumer instance.
diff number: Message backlog.
language string: Development language of the consumer application.
version string: Consumer version.

client_address str: Address and port of this consumer instance.
client_id str: ID of this consumer instance.
diff int: Message backlog.
language str: Development language of the consumer application.
version str: Consumer version.

clientAddress String: Address and port of this consumer instance.
clientId String: ID of this consumer instance.
diff Number: Message backlog.
language String: Development language of the consumer application.
version String: Consumer version.

GetGroupConsumedTopic

QueueNum int: Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.
SubString string: Subscription rules.
TopicName string: Name of the Topic subscribed by the client.

QueueNum int: Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.
SubString string: Subscription rules.
TopicName string: Name of the Topic subscribed by the client.

queueNum Integer: Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.
subString String: Subscription rules.
topicName String: Name of the Topic subscribed by the client.

queueNum number: Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.
subString string: Subscription rules.
topicName string: Name of the Topic subscribed by the client.

queue_num int: Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.
sub_string str: Subscription rules.
topic_name str: Name of the Topic subscribed by the client.

queueNum Number: Number of queues associated with the Topic. Each Topic contains one or more queues for storing messages.
subString String: Subscription rules.
topicName String: Name of the Topic subscribed by the client.