Deleting Multiple Consumer Groups
Function
This API is used to delete groups in batches.
URI
POST /v2/{project_id}/mqs/instances/{instance_id}/groups/batch-delete
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
instance_id |
Yes |
String |
Instance ID |
|
project_id |
Yes |
String |
Project ID |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
[items] |
No |
Array of strings |
IDs of all consumer groups to be deleted. |
Response Parameters
Status code: 200
|
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 |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
