Help Center/ ROMA Connect/ API Reference/ Message Integration APIs/ Consumer Group Management/ Deleting Multiple Consumer Groups
Updated on 2025-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting Multiple Consumer Groups

Function

This API is used to delete groups in batches.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v2/{project_id}/mqs/instances/{instance_id}/groups/batch-delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

[items]

No

Array of strings

IDs of all consumer groups to be deleted.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

failed_groups

Array of FailedGroupsEntity objects

List of consumer groups that failed to be deleted

total

Integer

Number of consumer groups that failed to be deleted
Table 4 FailedGroupsEntity

Parameter

Type

Description

group_id

String

ID of consumer groups that failed to be deleted

error_message

String

Cause of the deletion failure

Example Requests

This API is used to delete consumer groups in batches.

"POST https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/groups/batch-delete"

{
  "group_ids" : [ "get-sync-group0", "get-sync-group1" ]
}

Example Responses

Status code: 200

The consumer group is deleted successfully.

{
  "failed_groups" : [ ],
  "total" : 0
}

Status Codes

Status Code

Description

200

The consumer group is deleted successfully.

Error Codes

See Error Codes.