1. Packages
  2. Volcengine
  3. API Docs
  4. rocketmq
  5. getGroups
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.rocketmq.getGroups

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of rocketmq groups

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const foo = volcengine.rocketmq.getGroups({
    instanceId: "rocketmq-cnoeea6b32118fc2",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.rocketmq.get_groups(instance_id="rocketmq-cnoeea6b32118fc2")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rocketmq"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rocketmq.GetGroups(ctx, &rocketmq.GetGroupsArgs{
			InstanceId: "rocketmq-cnoeea6b32118fc2",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Rocketmq.GetGroups.Invoke(new()
    {
        InstanceId = "rocketmq-cnoeea6b32118fc2",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rocketmq.RocketmqFunctions;
import com.pulumi.volcengine.rocketmq.inputs.GetGroupsArgs;
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 foo = RocketmqFunctions.getGroups(GetGroupsArgs.builder()
            .instanceId("rocketmq-cnoeea6b32118fc2")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:rocketmq:getGroups
      Arguments:
        instanceId: rocketmq-cnoeea6b32118fc2

    Using getGroups

    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 getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function getGroupsOutput(args: GetGroupsOutputArgs, opts?: InvokeOptions): Output<GetGroupsResult>
    def get_groups(group_id: Optional[str] = None,
               group_type: Optional[str] = None,
               instance_id: Optional[str] = None,
               output_file: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(group_id: Optional[pulumi.Input[str]] = None,
               group_type: Optional[pulumi.Input[str]] = None,
               instance_id: Optional[pulumi.Input[str]] = None,
               output_file: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetGroupsResult]
    func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput

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

    public static class GetGroups 
{
    public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupsResult> Invoke(GetGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
public static Output<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:rocketmq/getGroups:getGroups
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The id of rocketmq instance.
    GroupId string
    The id of rocketmq group. This field support fuzzy query.
    GroupType string
    The type of rocketmq group. Valid values: TCP.
    OutputFile string
    File name where to save data source results.
    InstanceId string
    The id of rocketmq instance.
    GroupId string
    The id of rocketmq group. This field support fuzzy query.
    GroupType string
    The type of rocketmq group. Valid values: TCP.
    OutputFile string
    File name where to save data source results.
    instanceId String
    The id of rocketmq instance.
    groupId String
    The id of rocketmq group. This field support fuzzy query.
    groupType String
    The type of rocketmq group. Valid values: TCP.
    outputFile String
    File name where to save data source results.
    instanceId string
    The id of rocketmq instance.
    groupId string
    The id of rocketmq group. This field support fuzzy query.
    groupType string
    The type of rocketmq group. Valid values: TCP.
    outputFile string
    File name where to save data source results.
    instance_id str
    The id of rocketmq instance.
    group_id str
    The id of rocketmq group. This field support fuzzy query.
    group_type str
    The type of rocketmq group. Valid values: TCP.
    output_file str
    File name where to save data source results.
    instanceId String
    The id of rocketmq instance.
    groupId String
    The id of rocketmq group. This field support fuzzy query.
    groupType String
    The type of rocketmq group. Valid values: TCP.
    outputFile String
    File name where to save data source results.

    getGroups Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    RocketmqGroups List<GetGroupsRocketmqGroup>
    The collection of query.
    TotalCount int
    The total count of query.
    GroupId string
    The id of the rocketmq group.
    GroupType string
    The type of the rocketmq group.
    OutputFile string
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    RocketmqGroups []GetGroupsRocketmqGroup
    The collection of query.
    TotalCount int
    The total count of query.
    GroupId string
    The id of the rocketmq group.
    GroupType string
    The type of the rocketmq group.
    OutputFile string
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    rocketmqGroups List<GetGroupsRocketmqGroup>
    The collection of query.
    totalCount Integer
    The total count of query.
    groupId String
    The id of the rocketmq group.
    groupType String
    The type of the rocketmq group.
    outputFile String
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    rocketmqGroups GetGroupsRocketmqGroup[]
    The collection of query.
    totalCount number
    The total count of query.
    groupId string
    The id of the rocketmq group.
    groupType string
    The type of the rocketmq group.
    outputFile string
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    rocketmq_groups Sequence[GetGroupsRocketmqGroup]
    The collection of query.
    total_count int
    The total count of query.
    group_id str
    The id of the rocketmq group.
    group_type str
    The type of the rocketmq group.
    output_file str
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    rocketmqGroups List<Property Map>
    The collection of query.
    totalCount Number
    The total count of query.
    groupId String
    The id of the rocketmq group.
    groupType String
    The type of the rocketmq group.
    outputFile String

    Supporting Types

    GetGroupsRocketmqGroup

    ConsumedClients List<GetGroupsRocketmqGroupConsumedClient>
    The consumed topic information of the rocketmq group.
    ConsumedTopics List<GetGroupsRocketmqGroupConsumedTopic>
    The consumed topic information of the rocketmq group.
    CreateTime string
    The create time of the rocketmq group.
    Description string
    The description of the rocketmq group.
    GroupId string
    The id of rocketmq group. This field support fuzzy query.
    GroupType string
    The type of rocketmq group. Valid values: TCP.
    IsSubSame bool
    Whether the subscription relationship of consumer instance groups within the group is consistent.
    MessageDelayTime string
    The message delay time of the rocketmq group. The unit is milliseconds.
    MessageModel string
    The message model of the rocketmq group.
    Status string
    The status of the rocketmq group.
    TotalConsumeRate string
    The total consume rate of the rocketmq group. The unit is per second.
    TotalDiff int
    The total amount of unconsumed messages.
    ConsumedClients []GetGroupsRocketmqGroupConsumedClient
    The consumed topic information of the rocketmq group.
    ConsumedTopics []GetGroupsRocketmqGroupConsumedTopic
    The consumed topic information of the rocketmq group.
    CreateTime string
    The create time of the rocketmq group.
    Description string
    The description of the rocketmq group.
    GroupId string
    The id of rocketmq group. This field support fuzzy query.
    GroupType string
    The type of rocketmq group. Valid values: TCP.
    IsSubSame bool
    Whether the subscription relationship of consumer instance groups within the group is consistent.
    MessageDelayTime string
    The message delay time of the rocketmq group. The unit is milliseconds.
    MessageModel string
    The message model of the rocketmq group.
    Status string
    The status of the rocketmq group.
    TotalConsumeRate string
    The total consume rate of the rocketmq group. The unit is per second.
    TotalDiff int
    The total amount of unconsumed messages.
    consumedClients List<GetGroupsRocketmqGroupConsumedClient>
    The consumed topic information of the rocketmq group.
    consumedTopics List<GetGroupsRocketmqGroupConsumedTopic>
    The consumed topic information of the rocketmq group.
    createTime String
    The create time of the rocketmq group.
    description String
    The description of the rocketmq group.
    groupId String
    The id of rocketmq group. This field support fuzzy query.
    groupType String
    The type of rocketmq group. Valid values: TCP.
    isSubSame Boolean
    Whether the subscription relationship of consumer instance groups within the group is consistent.
    messageDelayTime String
    The message delay time of the rocketmq group. The unit is milliseconds.
    messageModel String
    The message model of the rocketmq group.
    status String
    The status of the rocketmq group.
    totalConsumeRate String
    The total consume rate of the rocketmq group. The unit is per second.
    totalDiff Integer
    The total amount of unconsumed messages.
    consumedClients GetGroupsRocketmqGroupConsumedClient[]
    The consumed topic information of the rocketmq group.
    consumedTopics GetGroupsRocketmqGroupConsumedTopic[]
    The consumed topic information of the rocketmq group.
    createTime string
    The create time of the rocketmq group.
    description string
    The description of the rocketmq group.
    groupId string
    The id of rocketmq group. This field support fuzzy query.
    groupType string
    The type of rocketmq group. Valid values: TCP.
    isSubSame boolean
    Whether the subscription relationship of consumer instance groups within the group is consistent.
    messageDelayTime string
    The message delay time of the rocketmq group. The unit is milliseconds.
    messageModel string
    The message model of the rocketmq group.
    status string
    The status of the rocketmq group.
    totalConsumeRate string
    The total consume rate of the rocketmq group. The unit is per second.
    totalDiff number
    The total amount of unconsumed messages.
    consumed_clients Sequence[GetGroupsRocketmqGroupConsumedClient]
    The consumed topic information of the rocketmq group.
    consumed_topics Sequence[GetGroupsRocketmqGroupConsumedTopic]
    The consumed topic information of the rocketmq group.
    create_time str
    The create time of the rocketmq group.
    description str
    The description of the rocketmq group.
    group_id str
    The id of rocketmq group. This field support fuzzy query.
    group_type str
    The type of rocketmq group. Valid values: TCP.
    is_sub_same bool
    Whether the subscription relationship of consumer instance groups within the group is consistent.
    message_delay_time str
    The message delay time of the rocketmq group. The unit is milliseconds.
    message_model str
    The message model of the rocketmq group.
    status str
    The status of the rocketmq group.
    total_consume_rate str
    The total consume rate of the rocketmq group. The unit is per second.
    total_diff int
    The total amount of unconsumed messages.
    consumedClients List<Property Map>
    The consumed topic information of the rocketmq group.
    consumedTopics List<Property Map>
    The consumed topic information of the rocketmq group.
    createTime String
    The create time of the rocketmq group.
    description String
    The description of the rocketmq group.
    groupId String
    The id of rocketmq group. This field support fuzzy query.
    groupType String
    The type of rocketmq group. Valid values: TCP.
    isSubSame Boolean
    Whether the subscription relationship of consumer instance groups within the group is consistent.
    messageDelayTime String
    The message delay time of the rocketmq group. The unit is milliseconds.
    messageModel String
    The message model of the rocketmq group.
    status String
    The status of the rocketmq group.
    totalConsumeRate String
    The total consume rate of the rocketmq group. The unit is per second.
    totalDiff Number
    The total amount of unconsumed messages.

    GetGroupsRocketmqGroupConsumedClient

    ClientAddress string
    The address of the consumed client.
    ClientId string
    The id of the consumed client.
    Diff int
    The amount of message.
    Language string
    The language of the consumed client.
    Version string
    The version of the consumed client.
    ClientAddress string
    The address of the consumed client.
    ClientId string
    The id of the consumed client.
    Diff int
    The amount of message.
    Language string
    The language of the consumed client.
    Version string
    The version of the consumed client.
    clientAddress String
    The address of the consumed client.
    clientId String
    The id of the consumed client.
    diff Integer
    The amount of message.
    language String
    The language of the consumed client.
    version String
    The version of the consumed client.
    clientAddress string
    The address of the consumed client.
    clientId string
    The id of the consumed client.
    diff number
    The amount of message.
    language string
    The language of the consumed client.
    version string
    The version of the consumed client.
    client_address str
    The address of the consumed client.
    client_id str
    The id of the consumed client.
    diff int
    The amount of message.
    language str
    The language of the consumed client.
    version str
    The version of the consumed client.
    clientAddress String
    The address of the consumed client.
    clientId String
    The id of the consumed client.
    diff Number
    The amount of message.
    language String
    The language of the consumed client.
    version String
    The version of the consumed client.

    GetGroupsRocketmqGroupConsumedTopic

    QueueNum int
    The queue number of the rocketmq topic.
    SubString string
    The sub string of the rocketmq topic.
    TopicName string
    The name of the rocketmq topic.
    QueueNum int
    The queue number of the rocketmq topic.
    SubString string
    The sub string of the rocketmq topic.
    TopicName string
    The name of the rocketmq topic.
    queueNum Integer
    The queue number of the rocketmq topic.
    subString String
    The sub string of the rocketmq topic.
    topicName String
    The name of the rocketmq topic.
    queueNum number
    The queue number of the rocketmq topic.
    subString string
    The sub string of the rocketmq topic.
    topicName string
    The name of the rocketmq topic.
    queue_num int
    The queue number of the rocketmq topic.
    sub_string str
    The sub string of the rocketmq topic.
    topic_name str
    The name of the rocketmq topic.
    queueNum Number
    The queue number of the rocketmq topic.
    subString String
    The sub string of the rocketmq topic.
    topicName String
    The name of the rocketmq topic.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate