OnsConsumerGetConnection - ApsaraMQ for RocketMQ - Centro de documentación de Alibaba Cloud

Descripción de la operación

Importante

La OpenAPI de Alibaba Cloud es una API de gestión que se utiliza para administrar y consultar recursos de servicios de Alibaba Cloud. Integre esta API únicamente con fines de gestión. No utilice esta API en el enlace de datos principal para enviar y recibir mensajes. El uso de esta API en el enlace de datos principal puede generar riesgos de seguridad.

Esta operación obtiene la información de conexión de los clientes en un grupo especificado cuando el consumo de mensajes es anómalo. Posteriormente, puede verificar el estado del consumidor para diagnosticar la causa.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

mq:QueryConsumerConnection

get

Group

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

Group

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

Ninguna

mq:OnsInstanceBaseInfo

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
GroupId	string	Sí	El ID del grupo a consultar.	GID_test_consumer_id
InstanceId	string	No	El ID de la instancia a la que pertenece el grupo.	MQ_INST_111111111111_DOxxxxxx

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud. Este es un parámetro común. Cada solicitud tiene un ID único. Utilice este ID para solucionar problemas.	DE4140C7-F42D-473D-A5FF-B1E31692****
Data	object	Los datos devueltos.
ConnectionList	object
ConnectionDo	array<object>	La información de conexión para el ID de grupo especificado.
	object
Version	string	La versión del cliente consumidor.	V4_3_6
ClientAddr	string	La dirección y el puerto de la instancia consumidora.	30.5.121.**
Language	string	El lenguaje de programación de la aplicación consumidora.	JAVA
ClientId	string	El ID de la instancia consumidora.	30.5.121.**@24813#-1999745829#-1737591554#453111174894656
MessageModel	string

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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": ""
  }
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.