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

Descripción de la operación

Importante

La OpenAPI proporcionada por Alibaba Cloud es una API de gestión utilizada para administrar y consultar recursos de los servicios de Alibaba Cloud. Se recomienda integrar la OpenAPI únicamente en enlaces de datos de gestión. No utilice la OpenAPI en enlaces de datos principales para enviar y recibir mensajes, ya que esto puede representar riesgos para los enlaces de datos.

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

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
InstanceId	string	Sí	El ID de la instancia a la que pertenece el grupo.	MQ_INST_111111111111_DOxxxxxx
GroupId	string	Sí	El ID del grupo que desea consultar.	GID_test_group_id

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	Un parámetro común. El ID de la solicitud. Cada solicitud tiene un ID único. Puede utilizar este ID para solucionar problemas.	3364E875-013B-442A-BC3C-C1A84DC6****
Data	object	El objeto Data devuelto.
SubscriptionDataList	object
SubscriptionDataList	array<object>	No se pueden consultar los datos si las instancias de consumidor del ID de grupo especificado están sin conexión.
	object
SubString	string	La expresión de suscripción.	*
Topic	string	El tema al que está suscrito el grupo.	test-mq_topic
GroupId	string	El ID del grupo que desea consultar.	GID_test_group_id
MessageModel	string	El patrón de consumo. Valores válidos: CLUSTERING: consumo por clúster BROADCASTING: consumo por difusión Para obtener más información sobre los patrones de consumo, consulte Consumo por clúster y consumo por difusión.	CLUSTERING
Online	boolean	Indica si el consumidor está en línea.	true

Ejemplos

Respuesta exitosa

JSON Formato

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

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.