1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. rocketmq
  5. getGroup
Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.rocketmq.getGroup

volcenginecc logo
Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::RocketMQ::Group

    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
    Group 内消费者实例群组的订阅关系是否一致。true：一致，false：不一致。
    ConsumedClients List<Volcengine.GetGroupConsumedClient>
    消费客户端列表。
    ConsumedTopics List<Volcengine.GetGroupConsumedTopic>
    该 Group 下消费者实例群组订阅的 Topic 信息。
    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。
    Id string
    Uniquely identifies the resource.
    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 []GetGroupConsumedClient
    消费客户端列表。
    ConsumedTopics []GetGroupConsumedTopic
    该 Group 下消费者实例群组订阅的 Topic 信息。
    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。
    Id string
    Uniquely identifies the resource.
    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<GetGroupConsumedClient>
    消费客户端列表。
    consumedTopics List<GetGroupConsumedTopic>
    该 Group 下消费者实例群组订阅的 Topic 信息。
    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。
    id String
    Uniquely identifies the resource.
    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 GetGroupConsumedClient[]
    消费客户端列表。
    consumedTopics GetGroupConsumedTopic[]
    该 Group 下消费者实例群组订阅的 Topic 信息。
    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。
    id string
    Uniquely identifies the resource.
    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[GetGroupConsumedClient]
    消费客户端列表。
    consumed_topics Sequence[GetGroupConsumedTopic]
    该 Group 下消费者实例群组订阅的 Topic 信息。
    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。
    id str
    Uniquely identifies the resource.
    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>
    该 Group 下消费者实例群组订阅的 Topic 信息。
    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。
    id String
    Uniquely identifies the resource.
    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

    GetGroupConsumedClient

    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
    消费端版本。

    GetGroupConsumedTopic

    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 名称。

    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
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.