Deletes a group ID.
Usage notes
You can call this operation when you need to recycle resources. For example, when applications are deleted, you need to recycle relevant resources.
After a group ID is deleted, the backend of Message Queue for Apache RocketMQ recycles resources of the group ID. This process is time-consuming. Therefore, we recommend that you do not create a group ID immediately after you delete one. If a group ID fails to be deleted, troubleshoot the issue based on the returned error code.
QPS limit
The queries-per-second (QPS) limit on this operation is 1 per user. Throttling is triggered when the number of calls to this operation per second exceeds the QPS limit. Throttling may affect your business. Therefore, call this operation based on your needs. For more information, see QPS limits.
Authorization information
By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after they are authorized to use it. The following table lists the authorization information of this operation. For more information, see Policies and examples.
API |
Action |
Resource (with namespace) |
Resource (without namespace) |
---|---|---|---|
OnsGroupDelete |
mq:DeleteGroup |
acs:mq:*:*:{instanceId}%{groupId} |
acs:mq:*:*:{groupId} |
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | OnsGroupDelete |
The operation that you want to perform. Set the value to OnsGroupDelete. |
GroupId | String | Yes | GID_test_groupId |
The group ID that you want to delete. |
InstanceId | String | Yes | MQ_INST_111111111111_DOxxxxxx |
The ID of the instance where the group ID you want to delete is located. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | A07E3902-B92E-44A6-B6C5-6AA111111**** |
The ID of the request, which is a common parameter. Each request has a unique ID to facilitate troubleshooting and fault locating. |
Examples
Sample requests
http(s)://ons.cn-hangzhou.aliyuncs.com/? Action=OnsGroupDelete
&GroupId=GID_test_groupId
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&<Common request parameters>
Sample success responses
XML
format
<OnsGroupDeleteResponse>
<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>
</OnsGroupDeleteResponse>
JSON
format
{
"RequestId":"A07E3902-B92E-44A6-B6C5-6AA111111****"
}
Error codes
For a list of error codes, visit the API Error Center.
Operations in the console
In addition to calling the OnsGroupDelete operation, you can delete a group ID in the Message Queue for Apache RocketMQ console. For more information, see Manage groups.