1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. rocketmq
  5. Group
Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine

    Group 即消费组(Consumer Group),是一类具有相同消费行为的消费者集合,用于分类管理不同的消费者。每个消费组消费不同种类的消息,且消息发布或订阅的逻辑一致。在消息队列 RocketMQ版中,您需要创建 Group,并通过 Group ID 标识不同类别的生产者或消费者。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const rocketMQGroupDemo = new volcenginecc.rocketmq.Group("RocketMQGroupDemo", {
        instanceId: "rocketmq-cnnxxxxxc2d",
        groupId: "ccapi-test-test-1",
        consumeMessageOrderly: true,
        description: "test",
        groupType: "TCP",
        retryMaxTimes: 2,
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    rocket_mq_group_demo = volcenginecc.rocketmq.Group("RocketMQGroupDemo",
        instance_id="rocketmq-cnnxxxxxc2d",
        group_id="ccapi-test-test-1",
        consume_message_orderly=True,
        description="test",
        group_type="TCP",
        retry_max_times=2)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rocketmq"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := rocketmq.NewGroup(ctx, "RocketMQGroupDemo", &rocketmq.GroupArgs{
    			InstanceId:            pulumi.String("rocketmq-cnnxxxxxc2d"),
    			GroupId:               pulumi.String("ccapi-test-test-1"),
    			ConsumeMessageOrderly: pulumi.Bool(true),
    			Description:           pulumi.String("test"),
    			GroupType:             pulumi.String("TCP"),
    			RetryMaxTimes:         pulumi.Int(2),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var rocketMQGroupDemo = new Volcenginecc.Rocketmq.Group("RocketMQGroupDemo", new()
        {
            InstanceId = "rocketmq-cnnxxxxxc2d",
            GroupId = "ccapi-test-test-1",
            ConsumeMessageOrderly = true,
            Description = "test",
            GroupType = "TCP",
            RetryMaxTimes = 2,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.rocketmq.Group;
    import com.volcengine.volcenginecc.rocketmq.GroupArgs;
    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) {
            var rocketMQGroupDemo = new Group("rocketMQGroupDemo", GroupArgs.builder()
                .instanceId("rocketmq-cnnxxxxxc2d")
                .groupId("ccapi-test-test-1")
                .consumeMessageOrderly(true)
                .description("test")
                .groupType("TCP")
                .retryMaxTimes(2)
                .build());
    
        }
    }
    
    resources:
      rocketMQGroupDemo:
        type: volcenginecc:rocketmq:Group
        name: RocketMQGroupDemo
        properties:
          instanceId: rocketmq-cnnxxxxxc2d
          groupId: ccapi-test-test-1
          consumeMessageOrderly: true
          description: test
          groupType: TCP
          retryMaxTimes: 2
    

    Create Group Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
    @overload
    def Group(resource_name: str,
              args: GroupArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Group(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              group_id: Optional[str] = None,
              group_type: Optional[str] = None,
              instance_id: Optional[str] = None,
              consume_message_orderly: Optional[bool] = None,
              description: Optional[str] = None,
              retry_max_times: Optional[int] = None)
    func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
    public Group(String name, GroupArgs args, CustomResourceOptions options)
    
    type: volcenginecc:rocketmq:Group
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var examplegroupResourceResourceFromRocketmqgroup = new Volcenginecc.Rocketmq.Group("examplegroupResourceResourceFromRocketmqgroup", new()
    {
        GroupId = "string",
        GroupType = "string",
        InstanceId = "string",
        ConsumeMessageOrderly = false,
        Description = "string",
        RetryMaxTimes = 0,
    });
    
    example, err := rocketmq.NewGroup(ctx, "examplegroupResourceResourceFromRocketmqgroup", &rocketmq.GroupArgs{
    	GroupId:               pulumi.String("string"),
    	GroupType:             pulumi.String("string"),
    	InstanceId:            pulumi.String("string"),
    	ConsumeMessageOrderly: pulumi.Bool(false),
    	Description:           pulumi.String("string"),
    	RetryMaxTimes:         pulumi.Int(0),
    })
    
    var examplegroupResourceResourceFromRocketmqgroup = new com.volcengine.volcenginecc.rocketmq.Group("examplegroupResourceResourceFromRocketmqgroup", com.volcengine.volcenginecc.rocketmq.GroupArgs.builder()
        .groupId("string")
        .groupType("string")
        .instanceId("string")
        .consumeMessageOrderly(false)
        .description("string")
        .retryMaxTimes(0)
        .build());
    
    examplegroup_resource_resource_from_rocketmqgroup = volcenginecc.rocketmq.Group("examplegroupResourceResourceFromRocketmqgroup",
        group_id="string",
        group_type="string",
        instance_id="string",
        consume_message_orderly=False,
        description="string",
        retry_max_times=0)
    
    const examplegroupResourceResourceFromRocketmqgroup = new volcenginecc.rocketmq.Group("examplegroupResourceResourceFromRocketmqgroup", {
        groupId: "string",
        groupType: "string",
        instanceId: "string",
        consumeMessageOrderly: false,
        description: "string",
        retryMaxTimes: 0,
    });
    
    type: volcenginecc:rocketmq:Group
    properties:
        consumeMessageOrderly: false
        description: string
        groupId: string
        groupType: string
        instanceId: string
        retryMaxTimes: 0
    

    Group Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Group resource accepts the following input properties:

    GroupId string
    Group 的 ID。长度限制为 7~120 个字符,只能包含字母、数字、短划线(-)和下划线()。推荐以 GID - 或 GID 开头。创建 Group 后无法修改 ID,请谨慎设置。对于2023年6月5日及之前创建的 RocketMQ 实例,Group 名称不可超过 93 个字符。
    GroupType string
    Group 的协议标识,用于备注该 Group 的生产消费协议类型。可指定为 TCP。
    InstanceId string
    实例 ID。
    ConsumeMessageOrderly bool
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    Description string
    Group 的简单描述。
    RetryMaxTimes int
    消费最大重试次数。
    GroupId string
    Group 的 ID。长度限制为 7~120 个字符,只能包含字母、数字、短划线(-)和下划线()。推荐以 GID - 或 GID 开头。创建 Group 后无法修改 ID,请谨慎设置。对于2023年6月5日及之前创建的 RocketMQ 实例,Group 名称不可超过 93 个字符。
    GroupType string
    Group 的协议标识,用于备注该 Group 的生产消费协议类型。可指定为 TCP。
    InstanceId string
    实例 ID。
    ConsumeMessageOrderly bool
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    Description string
    Group 的简单描述。
    RetryMaxTimes int
    消费最大重试次数。
    groupId String
    Group 的 ID。长度限制为 7~120 个字符,只能包含字母、数字、短划线(-)和下划线()。推荐以 GID - 或 GID 开头。创建 Group 后无法修改 ID,请谨慎设置。对于2023年6月5日及之前创建的 RocketMQ 实例,Group 名称不可超过 93 个字符。
    groupType String
    Group 的协议标识,用于备注该 Group 的生产消费协议类型。可指定为 TCP。
    instanceId String
    实例 ID。
    consumeMessageOrderly Boolean
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    description String
    Group 的简单描述。
    retryMaxTimes Integer
    消费最大重试次数。
    groupId string
    Group 的 ID。长度限制为 7~120 个字符,只能包含字母、数字、短划线(-)和下划线()。推荐以 GID - 或 GID 开头。创建 Group 后无法修改 ID,请谨慎设置。对于2023年6月5日及之前创建的 RocketMQ 实例,Group 名称不可超过 93 个字符。
    groupType string
    Group 的协议标识,用于备注该 Group 的生产消费协议类型。可指定为 TCP。
    instanceId string
    实例 ID。
    consumeMessageOrderly boolean
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    description string
    Group 的简单描述。
    retryMaxTimes number
    消费最大重试次数。
    group_id str
    Group 的 ID。长度限制为 7~120 个字符,只能包含字母、数字、短划线(-)和下划线()。推荐以 GID - 或 GID 开头。创建 Group 后无法修改 ID,请谨慎设置。对于2023年6月5日及之前创建的 RocketMQ 实例,Group 名称不可超过 93 个字符。
    group_type str
    Group 的协议标识,用于备注该 Group 的生产消费协议类型。可指定为 TCP。
    instance_id str
    实例 ID。
    consume_message_orderly bool
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    description str
    Group 的简单描述。
    retry_max_times int
    消费最大重试次数。
    groupId String
    Group 的 ID。长度限制为 7~120 个字符,只能包含字母、数字、短划线(-)和下划线()。推荐以 GID - 或 GID 开头。创建 Group 后无法修改 ID,请谨慎设置。对于2023年6月5日及之前创建的 RocketMQ 实例,Group 名称不可超过 93 个字符。
    groupType String
    Group 的协议标识,用于备注该 Group 的生产消费协议类型。可指定为 TCP。
    instanceId String
    实例 ID。
    consumeMessageOrderly Boolean
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    description String
    Group 的简单描述。
    retryMaxTimes Number
    消费最大重试次数。

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

    ConsumedClients List<Volcengine.GroupConsumedClient>
    ConsumedTopics List<Volcengine.GroupConsumedTopic>
    CreatedTime string
    Group 的创建时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    IsSubSame bool
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    LastUpdateTimestamp string
    是否顺序消费。
    MessageDelayTime string
    消息延迟时间,消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。
    MessageModel string
    消息消费模式。默认为集群模式,请勿在同一 Group 下同时配置集群模式和广播模式。Clustering:集群消费模式,Broadcasting:广播消费模式。
    RocketmqVersion string
    RocketMQ 版本。
    ServiceStatus string
    服务状态。Creating:创建中,Running:运行中,Deleting:删除中,Abnormal:异常,Updating:更新中。
    Status string
    消费组状态。Online:消费中,Offline:未消费。
    TotalConsumedRate string
    该 Group 下消费者实例群组接收消息的总 TPS,单位为条/秒。
    TotalDiff int
    消费者实例群组的未消费消息的总量。此处显示的消息堆积量为未过滤 Tag 的总堆积量,包括 Topic 下所有 Tag 的消息。
    ConsumedClients []GroupConsumedClient
    ConsumedTopics []GroupConsumedTopic
    CreatedTime string
    Group 的创建时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    IsSubSame bool
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    LastUpdateTimestamp string
    是否顺序消费。
    MessageDelayTime string
    消息延迟时间,消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。
    MessageModel string
    消息消费模式。默认为集群模式,请勿在同一 Group 下同时配置集群模式和广播模式。Clustering:集群消费模式,Broadcasting:广播消费模式。
    RocketmqVersion string
    RocketMQ 版本。
    ServiceStatus string
    服务状态。Creating:创建中,Running:运行中,Deleting:删除中,Abnormal:异常,Updating:更新中。
    Status string
    消费组状态。Online:消费中,Offline:未消费。
    TotalConsumedRate string
    该 Group 下消费者实例群组接收消息的总 TPS,单位为条/秒。
    TotalDiff int
    消费者实例群组的未消费消息的总量。此处显示的消息堆积量为未过滤 Tag 的总堆积量,包括 Topic 下所有 Tag 的消息。
    consumedClients List<GroupConsumedClient>
    consumedTopics List<GroupConsumedTopic>
    createdTime String
    Group 的创建时间。
    id String
    The provider-assigned unique ID for this managed resource.
    isSubSame Boolean
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    lastUpdateTimestamp String
    是否顺序消费。
    messageDelayTime String
    消息延迟时间,消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。
    messageModel String
    消息消费模式。默认为集群模式,请勿在同一 Group 下同时配置集群模式和广播模式。Clustering:集群消费模式,Broadcasting:广播消费模式。
    rocketmqVersion String
    RocketMQ 版本。
    serviceStatus String
    服务状态。Creating:创建中,Running:运行中,Deleting:删除中,Abnormal:异常,Updating:更新中。
    status String
    消费组状态。Online:消费中,Offline:未消费。
    totalConsumedRate String
    该 Group 下消费者实例群组接收消息的总 TPS,单位为条/秒。
    totalDiff Integer
    消费者实例群组的未消费消息的总量。此处显示的消息堆积量为未过滤 Tag 的总堆积量,包括 Topic 下所有 Tag 的消息。
    consumedClients GroupConsumedClient[]
    consumedTopics GroupConsumedTopic[]
    createdTime string
    Group 的创建时间。
    id string
    The provider-assigned unique ID for this managed resource.
    isSubSame boolean
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    lastUpdateTimestamp string
    是否顺序消费。
    messageDelayTime string
    消息延迟时间,消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。
    messageModel string
    消息消费模式。默认为集群模式,请勿在同一 Group 下同时配置集群模式和广播模式。Clustering:集群消费模式,Broadcasting:广播消费模式。
    rocketmqVersion string
    RocketMQ 版本。
    serviceStatus string
    服务状态。Creating:创建中,Running:运行中,Deleting:删除中,Abnormal:异常,Updating:更新中。
    status string
    消费组状态。Online:消费中,Offline:未消费。
    totalConsumedRate string
    该 Group 下消费者实例群组接收消息的总 TPS,单位为条/秒。
    totalDiff number
    消费者实例群组的未消费消息的总量。此处显示的消息堆积量为未过滤 Tag 的总堆积量,包括 Topic 下所有 Tag 的消息。
    consumed_clients Sequence[GroupConsumedClient]
    consumed_topics Sequence[GroupConsumedTopic]
    created_time str
    Group 的创建时间。
    id str
    The provider-assigned unique ID for this managed resource.
    is_sub_same bool
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    last_update_timestamp str
    是否顺序消费。
    message_delay_time str
    消息延迟时间,消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。
    message_model str
    消息消费模式。默认为集群模式,请勿在同一 Group 下同时配置集群模式和广播模式。Clustering:集群消费模式,Broadcasting:广播消费模式。
    rocketmq_version str
    RocketMQ 版本。
    service_status str
    服务状态。Creating:创建中,Running:运行中,Deleting:删除中,Abnormal:异常,Updating:更新中。
    status str
    消费组状态。Online:消费中,Offline:未消费。
    total_consumed_rate str
    该 Group 下消费者实例群组接收消息的总 TPS,单位为条/秒。
    total_diff int
    消费者实例群组的未消费消息的总量。此处显示的消息堆积量为未过滤 Tag 的总堆积量,包括 Topic 下所有 Tag 的消息。
    consumedClients List<Property Map>
    consumedTopics List<Property Map>
    createdTime String
    Group 的创建时间。
    id String
    The provider-assigned unique ID for this managed resource.
    isSubSame Boolean
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    lastUpdateTimestamp String
    是否顺序消费。
    messageDelayTime String
    消息延迟时间,消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。
    messageModel String
    消息消费模式。默认为集群模式,请勿在同一 Group 下同时配置集群模式和广播模式。Clustering:集群消费模式,Broadcasting:广播消费模式。
    rocketmqVersion String
    RocketMQ 版本。
    serviceStatus String
    服务状态。Creating:创建中,Running:运行中,Deleting:删除中,Abnormal:异常,Updating:更新中。
    status String
    消费组状态。Online:消费中,Offline:未消费。
    totalConsumedRate String
    该 Group 下消费者实例群组接收消息的总 TPS,单位为条/秒。
    totalDiff Number
    消费者实例群组的未消费消息的总量。此处显示的消息堆积量为未过滤 Tag 的总堆积量,包括 Topic 下所有 Tag 的消息。

    Look up Existing Group Resource

    Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            consume_message_orderly: Optional[bool] = None,
            consumed_clients: Optional[Sequence[GroupConsumedClientArgs]] = None,
            consumed_topics: Optional[Sequence[GroupConsumedTopicArgs]] = None,
            created_time: Optional[str] = None,
            description: Optional[str] = None,
            group_id: Optional[str] = None,
            group_type: Optional[str] = None,
            instance_id: Optional[str] = None,
            is_sub_same: Optional[bool] = None,
            last_update_timestamp: Optional[str] = None,
            message_delay_time: Optional[str] = None,
            message_model: Optional[str] = None,
            retry_max_times: Optional[int] = None,
            rocketmq_version: Optional[str] = None,
            service_status: Optional[str] = None,
            status: Optional[str] = None,
            total_consumed_rate: Optional[str] = None,
            total_diff: Optional[int] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:rocketmq:Group    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ConsumeMessageOrderly bool
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    ConsumedClients List<Volcengine.GroupConsumedClient>
    ConsumedTopics List<Volcengine.GroupConsumedTopic>
    CreatedTime string
    Group 的创建时间。
    Description string
    Group 的简单描述。
    GroupId string
    Group 的 ID。长度限制为 7~120 个字符,只能包含字母、数字、短划线(-)和下划线()。推荐以 GID - 或 GID 开头。创建 Group 后无法修改 ID,请谨慎设置。对于2023年6月5日及之前创建的 RocketMQ 实例,Group 名称不可超过 93 个字符。
    GroupType string
    Group 的协议标识,用于备注该 Group 的生产消费协议类型。可指定为 TCP。
    InstanceId string
    实例 ID。
    IsSubSame bool
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    LastUpdateTimestamp string
    是否顺序消费。
    MessageDelayTime string
    消息延迟时间,消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。
    MessageModel string
    消息消费模式。默认为集群模式,请勿在同一 Group 下同时配置集群模式和广播模式。Clustering:集群消费模式,Broadcasting:广播消费模式。
    RetryMaxTimes int
    消费最大重试次数。
    RocketmqVersion string
    RocketMQ 版本。
    ServiceStatus string
    服务状态。Creating:创建中,Running:运行中,Deleting:删除中,Abnormal:异常,Updating:更新中。
    Status string
    消费组状态。Online:消费中,Offline:未消费。
    TotalConsumedRate string
    该 Group 下消费者实例群组接收消息的总 TPS,单位为条/秒。
    TotalDiff int
    消费者实例群组的未消费消息的总量。此处显示的消息堆积量为未过滤 Tag 的总堆积量,包括 Topic 下所有 Tag 的消息。
    ConsumeMessageOrderly bool
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    ConsumedClients []GroupConsumedClientArgs
    ConsumedTopics []GroupConsumedTopicArgs
    CreatedTime string
    Group 的创建时间。
    Description string
    Group 的简单描述。
    GroupId string
    Group 的 ID。长度限制为 7~120 个字符,只能包含字母、数字、短划线(-)和下划线()。推荐以 GID - 或 GID 开头。创建 Group 后无法修改 ID,请谨慎设置。对于2023年6月5日及之前创建的 RocketMQ 实例,Group 名称不可超过 93 个字符。
    GroupType string
    Group 的协议标识,用于备注该 Group 的生产消费协议类型。可指定为 TCP。
    InstanceId string
    实例 ID。
    IsSubSame bool
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    LastUpdateTimestamp string
    是否顺序消费。
    MessageDelayTime string
    消息延迟时间,消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。
    MessageModel string
    消息消费模式。默认为集群模式,请勿在同一 Group 下同时配置集群模式和广播模式。Clustering:集群消费模式,Broadcasting:广播消费模式。
    RetryMaxTimes int
    消费最大重试次数。
    RocketmqVersion string
    RocketMQ 版本。
    ServiceStatus string
    服务状态。Creating:创建中,Running:运行中,Deleting:删除中,Abnormal:异常,Updating:更新中。
    Status string
    消费组状态。Online:消费中,Offline:未消费。
    TotalConsumedRate string
    该 Group 下消费者实例群组接收消息的总 TPS,单位为条/秒。
    TotalDiff int
    消费者实例群组的未消费消息的总量。此处显示的消息堆积量为未过滤 Tag 的总堆积量,包括 Topic 下所有 Tag 的消息。
    consumeMessageOrderly Boolean
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    consumedClients List<GroupConsumedClient>
    consumedTopics List<GroupConsumedTopic>
    createdTime String
    Group 的创建时间。
    description String
    Group 的简单描述。
    groupId String
    Group 的 ID。长度限制为 7~120 个字符,只能包含字母、数字、短划线(-)和下划线()。推荐以 GID - 或 GID 开头。创建 Group 后无法修改 ID,请谨慎设置。对于2023年6月5日及之前创建的 RocketMQ 实例,Group 名称不可超过 93 个字符。
    groupType String
    Group 的协议标识,用于备注该 Group 的生产消费协议类型。可指定为 TCP。
    instanceId String
    实例 ID。
    isSubSame Boolean
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    lastUpdateTimestamp String
    是否顺序消费。
    messageDelayTime String
    消息延迟时间,消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。
    messageModel String
    消息消费模式。默认为集群模式,请勿在同一 Group 下同时配置集群模式和广播模式。Clustering:集群消费模式,Broadcasting:广播消费模式。
    retryMaxTimes Integer
    消费最大重试次数。
    rocketmqVersion String
    RocketMQ 版本。
    serviceStatus String
    服务状态。Creating:创建中,Running:运行中,Deleting:删除中,Abnormal:异常,Updating:更新中。
    status String
    消费组状态。Online:消费中,Offline:未消费。
    totalConsumedRate String
    该 Group 下消费者实例群组接收消息的总 TPS,单位为条/秒。
    totalDiff Integer
    消费者实例群组的未消费消息的总量。此处显示的消息堆积量为未过滤 Tag 的总堆积量,包括 Topic 下所有 Tag 的消息。
    consumeMessageOrderly boolean
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    consumedClients GroupConsumedClient[]
    consumedTopics GroupConsumedTopic[]
    createdTime string
    Group 的创建时间。
    description string
    Group 的简单描述。
    groupId string
    Group 的 ID。长度限制为 7~120 个字符,只能包含字母、数字、短划线(-)和下划线()。推荐以 GID - 或 GID 开头。创建 Group 后无法修改 ID,请谨慎设置。对于2023年6月5日及之前创建的 RocketMQ 实例,Group 名称不可超过 93 个字符。
    groupType string
    Group 的协议标识,用于备注该 Group 的生产消费协议类型。可指定为 TCP。
    instanceId string
    实例 ID。
    isSubSame boolean
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    lastUpdateTimestamp string
    是否顺序消费。
    messageDelayTime string
    消息延迟时间,消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。
    messageModel string
    消息消费模式。默认为集群模式,请勿在同一 Group 下同时配置集群模式和广播模式。Clustering:集群消费模式,Broadcasting:广播消费模式。
    retryMaxTimes number
    消费最大重试次数。
    rocketmqVersion string
    RocketMQ 版本。
    serviceStatus string
    服务状态。Creating:创建中,Running:运行中,Deleting:删除中,Abnormal:异常,Updating:更新中。
    status string
    消费组状态。Online:消费中,Offline:未消费。
    totalConsumedRate string
    该 Group 下消费者实例群组接收消息的总 TPS,单位为条/秒。
    totalDiff number
    消费者实例群组的未消费消息的总量。此处显示的消息堆积量为未过滤 Tag 的总堆积量,包括 Topic 下所有 Tag 的消息。
    consume_message_orderly bool
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    consumed_clients Sequence[GroupConsumedClientArgs]
    consumed_topics Sequence[GroupConsumedTopicArgs]
    created_time str
    Group 的创建时间。
    description str
    Group 的简单描述。
    group_id str
    Group 的 ID。长度限制为 7~120 个字符,只能包含字母、数字、短划线(-)和下划线()。推荐以 GID - 或 GID 开头。创建 Group 后无法修改 ID,请谨慎设置。对于2023年6月5日及之前创建的 RocketMQ 实例,Group 名称不可超过 93 个字符。
    group_type str
    Group 的协议标识,用于备注该 Group 的生产消费协议类型。可指定为 TCP。
    instance_id str
    实例 ID。
    is_sub_same bool
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    last_update_timestamp str
    是否顺序消费。
    message_delay_time str
    消息延迟时间,消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。
    message_model str
    消息消费模式。默认为集群模式,请勿在同一 Group 下同时配置集群模式和广播模式。Clustering:集群消费模式,Broadcasting:广播消费模式。
    retry_max_times int
    消费最大重试次数。
    rocketmq_version str
    RocketMQ 版本。
    service_status str
    服务状态。Creating:创建中,Running:运行中,Deleting:删除中,Abnormal:异常,Updating:更新中。
    status str
    消费组状态。Online:消费中,Offline:未消费。
    total_consumed_rate str
    该 Group 下消费者实例群组接收消息的总 TPS,单位为条/秒。
    total_diff int
    消费者实例群组的未消费消息的总量。此处显示的消息堆积量为未过滤 Tag 的总堆积量,包括 Topic 下所有 Tag 的消息。
    consumeMessageOrderly Boolean
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    consumedClients List<Property Map>
    consumedTopics List<Property Map>
    createdTime String
    Group 的创建时间。
    description String
    Group 的简单描述。
    groupId String
    Group 的 ID。长度限制为 7~120 个字符,只能包含字母、数字、短划线(-)和下划线()。推荐以 GID - 或 GID 开头。创建 Group 后无法修改 ID,请谨慎设置。对于2023年6月5日及之前创建的 RocketMQ 实例,Group 名称不可超过 93 个字符。
    groupType String
    Group 的协议标识,用于备注该 Group 的生产消费协议类型。可指定为 TCP。
    instanceId String
    实例 ID。
    isSubSame Boolean
    Group 内消费者实例群组的订阅关系是否一致。true:一致,false:不一致。
    lastUpdateTimestamp String
    是否顺序消费。
    messageDelayTime String
    消息延迟时间,消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。
    messageModel String
    消息消费模式。默认为集群模式,请勿在同一 Group 下同时配置集群模式和广播模式。Clustering:集群消费模式,Broadcasting:广播消费模式。
    retryMaxTimes Number
    消费最大重试次数。
    rocketmqVersion String
    RocketMQ 版本。
    serviceStatus String
    服务状态。Creating:创建中,Running:运行中,Deleting:删除中,Abnormal:异常,Updating:更新中。
    status String
    消费组状态。Online:消费中,Offline:未消费。
    totalConsumedRate String
    该 Group 下消费者实例群组接收消息的总 TPS,单位为条/秒。
    totalDiff Number
    消费者实例群组的未消费消息的总量。此处显示的消息堆积量为未过滤 Tag 的总堆积量,包括 Topic 下所有 Tag 的消息。

    Supporting Types

    GroupConsumedClient, GroupConsumedClientArgs

    ClientAddress string
    该消费者实例的地址和端口。
    ClientId string
    该消费者实例的 ID。
    Diff int
    消息堆积量。
    Language string
    消费者应用的开发语言。
    Version string
    消费端版本。
    ClientAddress string
    该消费者实例的地址和端口。
    ClientId string
    该消费者实例的 ID。
    Diff int
    消息堆积量。
    Language string
    消费者应用的开发语言。
    Version string
    消费端版本。
    clientAddress String
    该消费者实例的地址和端口。
    clientId String
    该消费者实例的 ID。
    diff Integer
    消息堆积量。
    language String
    消费者应用的开发语言。
    version String
    消费端版本。
    clientAddress string
    该消费者实例的地址和端口。
    clientId string
    该消费者实例的 ID。
    diff number
    消息堆积量。
    language string
    消费者应用的开发语言。
    version string
    消费端版本。
    client_address str
    该消费者实例的地址和端口。
    client_id str
    该消费者实例的 ID。
    diff int
    消息堆积量。
    language str
    消费者应用的开发语言。
    version str
    消费端版本。
    clientAddress String
    该消费者实例的地址和端口。
    clientId String
    该消费者实例的 ID。
    diff Number
    消息堆积量。
    language String
    消费者应用的开发语言。
    version String
    消费端版本。

    GroupConsumedTopic, GroupConsumedTopicArgs

    QueueNum int
    Topic 对应的队列数。每个 Topic 下有一到多个队列用于存储消息。
    SubString string
    订阅规则。
    TopicName string
    客户端订阅的 Topic 名称。
    QueueNum int
    Topic 对应的队列数。每个 Topic 下有一到多个队列用于存储消息。
    SubString string
    订阅规则。
    TopicName string
    客户端订阅的 Topic 名称。
    queueNum Integer
    Topic 对应的队列数。每个 Topic 下有一到多个队列用于存储消息。
    subString String
    订阅规则。
    topicName String
    客户端订阅的 Topic 名称。
    queueNum number
    Topic 对应的队列数。每个 Topic 下有一到多个队列用于存储消息。
    subString string
    订阅规则。
    topicName string
    客户端订阅的 Topic 名称。
    queue_num int
    Topic 对应的队列数。每个 Topic 下有一到多个队列用于存储消息。
    sub_string str
    订阅规则。
    topic_name str
    客户端订阅的 Topic 名称。
    queueNum Number
    Topic 对应的队列数。每个 Topic 下有一到多个队列用于存储消息。
    subString String
    订阅规则。
    topicName String
    客户端订阅的 Topic 名称。

    Import

    $ pulumi import volcenginecc:rocketmq/group:Group example "instance_id|group_id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.24
    published on Monday, Mar 9, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.