OnsGroupConsumerUpdate - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Sets the message read permission for the consumer cluster that corresponds to a specified group ID. This operation is typically used to prevent a specific consumer group from reading messages.

Operation description

Important Alibaba Cloud OpenAPI is a control-plane API used to manage and query Alibaba Cloud service resources. Integrate OpenAPI only on the control plane. Do not depend on OpenAPI for core data links that send and receive messages. This can introduce threats to your data links.

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:UpdateGroupConsumer

Group

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

Group

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

None

mq:OnsInstanceBaseInfo

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The group ID to configure.	GID_test_groupId
ReadEnable	boolean	Yes	Specifies whether the consumer cluster for the group ID has permission to read messages. Valid values: true: The consumer cluster has permission to read messages. false: The consumer cluster does not have permission to read messages. Default value: true.	true
InstanceId	string	No	The ID of the instance to which the group ID belongs.	MQ_INST_111111111111_DOxxxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. This is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot and locate 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.