OnsConsumerGetConnection-阿里云帮助中心

Operation description

Important Alibaba Cloud OpenAPI operations are management API operations used to manage and query resources of Alibaba Cloud services. Integrate these operations only into management links. Do not rely on OpenAPI operations in the core data link for message sending and receiving. Otherwise, risks may occur in the link.

This operation is typically used to obtain the connection information of clients under a specified group ID when consumption exceptions occur. You can view the consumer status to preliminarily diagnose the cause.

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

get

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 ID of the group.	GID_test_consumer_id
InstanceId	string	No	The instance ID corresponding to the group ID.	MQ_INST_111111111111_DOxxxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. This is a common parameter. Each request has a unique ID that can be used to troubleshoot and locate issues.	DE4140C7-F42D-473D-A5FF-B1E31692****
Data	object	The response data structure.
ConnectionList	object
ConnectionDo	array<object>	The connection information of the specified group ID.
	object
Version	string	The version of the consumer client.	V4_3_6
ClientAddr	string	The IP address and port of the consumer instance.	30.5.121.**
Language	string	The development language of the consumer application.	JAVA
ClientId	string	The ID of the consumer instance.	30.5.121.**@24813#-1999745829#-1737591554#453111174894656
MessageModel	string	The consumption mode. Valid values: CLUSTERING: clustered consumption. BROADCASTING: broadcast consumption.	CLUSTERING

Examples

Success response

JSON format

{
  "RequestId": "DE4140C7-F42D-473D-A5FF-B1E31692****",
  "Data": {
    "ConnectionList": {
      "ConnectionDo": [
        {
          "Version": "V4_3_6",
          "ClientAddr": "30.5.121.**",
          "Language": "JAVA",
          "ClientId": "30.5.121.**@24813#-1999745829#-1737591554#453111174894656"
        }
      ]
    },
    "MessageModel": "CLUSTERING"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.