Chen, Junjie ef239b7410 DMS API-REF 20230201 Version

Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>

2024-07-03 17:41:26 +00:00

6.8 KiB

Raw Blame History

Creating a Consumer Group

Function

This API is used to create a consumer group.

URI

POST /v2/{project_id}/kafka/instances/{instance_id}/group

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
group_name	Yes	String	Consumer group name.
group_desc	No	String	Consumer group description. Minimum: 0 Maximum: 200

Response Parameters

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

Creating a consumer group named test

POST https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/group

{
  "group_name" : "test"
}

Example Responses

Status code: 200

Creation succeeded.

success

Status Codes

Status Code	Description
200	Creation succeeded.
400	Creation failed.

Error Codes

See Error Codes.

Parent topic: Instance Management

6.8 KiB Raw Blame History