OnsGroupDelete - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Operation description

Important

The OpenAPI provided by Alibaba Cloud are management APIs. Use these APIs to manage and query resources of Alibaba Cloud services. Integrate these APIs only on the management data link. Do not use OpenAPI on the core data link for sending and receiving messages because this can introduce threats to the data link.
After a group is deleted, the consumer instances identified by the group ID immediately stop receiving messages. Call this operation with caution.

This operation is typically used for resource revocation, such as when an application is unpublished. When a group is deleted, the system revokes resources in the background. This process is slow. Do not immediately recreate a group after you delete it. If the deletion fails, handle the failure based on the returned error code.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mq:DeleteGroup

delete

*Group

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

*Group

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}

None

mq:QueryInstanceBaseInfo

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the group that you want to delete.	GID_test_groupId
InstanceId	string	No	The ID of the instance to which the group that you want to delete belongs.	MQ_INST_111111111111_DOxxxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. This ID is unique to each request. Use this ID to locate and troubleshoot issues.	A07E3902-B92E-44A6-B6C5-6AA111111****

Examples

Success response

JSON format

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.