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

Descripción de la operación

Nota

Las operaciones de API proporcionadas por Alibaba Cloud se utilizan para administrar y consultar recursos de los servicios de Alibaba Cloud. Se recomienda integrar estas operaciones de API únicamente en sistemas de administración. No utilice estas operaciones de API en el sistema principal de los servicios de mensajería. De lo contrario, pueden producirse riesgos en el sistema.

Puede determinar el uso de recursos de un tema basándose en la información que devuelve esta operación. La información devuelta incluye el número total de mensajes en el tema y el momento más reciente en que se publicó un mensaje en el tema.

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

get

Topic

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

Topic

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

Ninguna

mq:OnsInstanceBaseInfo

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Topic	string	Sí	El nombre del tema que desea consultar.	test
InstanceId	string	No	El ID de la instancia que contiene el tema que desea consultar.	MQ_INST_188077086902****_BXSuW61e

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El mensaje devuelto.
RequestId	string	El ID de la solicitud. Este parámetro es un parámetro común. Cada solicitud tiene un ID único. Puede utilizar este ID para solucionar problemas.	427EE49D-D762-41FB-8F3D-9BAC96C3****
Data	object	La estructura de datos del tema consultado.
Perm	integer	Indica las operaciones que puede realizar en el tema. Valores válidos: 2: Puede publicar mensajes en el tema. 4: Puede suscribirse al tema. 6: Puede publicar mensajes en el tema y suscribirse a él.	6
LastTimeStamp	integer	El momento en que el último mensaje está listo en el tema. Si no existe ningún mensaje en el tema, el valor devuelto de este parámetro es 0. El valor de este parámetro es una marca de tiempo UNIX en milisegundos. Para obtener información sobre la definición de mensajes listos y tiempo de disponibilidad, consulte Términos.	1570864984364
TotalCount	integer	El número total de mensajes en todas las particiones del tema.	2310

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "427EE49D-D762-41FB-8F3D-9BAC96C3****",
  "Data": {
    "Perm": 6,
    "LastTimeStamp": 1570864984364,
    "TotalCount": 2310
  }
}

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.