CreateConsumerGroup

Updated at:
Copy as MD

Creates a consumer group.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

GwClusterId

string

Yes

The ID of the gateway instance.

pg-xxxxxxx

ConsumerGroupName

string

Yes

The name of the consumer group.

test

NickName

string

No

The nickname of the consumer group.

test

IsDefault

string

No

Indicates whether the consumer group is the default group. Valid values:

  • 0: No

  • 1: Yes

0

RegionId

string

No

The ID of the region where the consumer group will be created.

cn-beijing

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The request ID.

A7E6A8FD-C50B-46B2-BA85-D8B8D3******

ConsumerGroupId

string

The ID of the created consumer group.

cg-xxxxxx

Examples

Success response

JSON format

{
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "ConsumerGroupId": "cg-xxxxxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.