Apache RocketMQ · JSON Structure

Apache Rocketmq Consumer Group Request Structure

Request to create a consumer group

Type: object Properties: 3 Required: 1
Cloud NativeMessagingMessage QueuePub-SubStreamingApacheOpen Source

ConsumerGroupRequest is a JSON Structure definition published by Apache RocketMQ, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name consumeFromWhere messageModel

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-rocketmq/refs/heads/main/json-structure/apache-rocketmq-consumer-group-request-structure.json",
  "description": "Request to create a consumer group",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Consumer group name"
    },
    "consumeFromWhere": {
      "type": "string",
      "enum": [
        "CONSUME_FROM_LAST_OFFSET",
        "CONSUME_FROM_FIRST_OFFSET"
      ]
    },
    "messageModel": {
      "type": "string",
      "enum": [
        "BROADCASTING",
        "CLUSTERING"
      ]
    }
  },
  "required": [
    "name"
  ],
  "name": "ConsumerGroupRequest"
}