OnsGroupSubDetail - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Operation description

Important The OpenAPI provided by Alibaba Cloud is a management API used to manage and query resources of Alibaba Cloud services. We recommend that you integrate OpenAPI only in management data links. Do not use OpenAPI in core data links for sending and receiving messages. This may pose risks to the 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:QueryGroupSubDetail

get

Group

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

Group

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

None

mq:OnsInstanceBaseInfo

Request parameters

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	A common parameter. The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.	3364E875-013B-442A-BC3C-C1A84DC6****
Data	object	The returned Data object.
SubscriptionDataList	object
SubscriptionDataList	array<object>	Data cannot be queried if the consumer instances of the specified group ID are offline.
	object
SubString	string	The subscription expression.	*
Topic	string	The topic to which the group subscribes.	test-mq_topic
GroupId	string	The ID of the group that you want to query.	GID_test_group_id
MessageModel	string	The consumption pattern. Valid values: CLUSTERING: clustering consumption BROADCASTING: broadcasting consumption For more information about consumption patterns, see Clustering consumption and broadcasting consumption.	CLUSTERING
Online	boolean	Indicates whether the consumer is online.	true

Examples

Success response

JSON format

{
  "RequestId": "3364E875-013B-442A-BC3C-C1A84DC6****",
  "Data": {
    "SubscriptionDataList": {
      "SubscriptionDataList": [
        {
          "SubString": "*",
          "Topic": "test-mq_topic"
        }
      ]
    },
    "GroupId": "GID_test_group_id",
    "MessageModel": "CLUSTERING",
    "Online": true
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.