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

Consulta información sobre todos los temas de su cuenta.

Descripción de la operación

Importante La OpenAPI de Alibaba Cloud es una API de gestión que puede utilizar para administrar y consultar recursos de los servicios de Alibaba Cloud. Integre esta API únicamente con fines de gestión. No dependa de esta API para enlaces de datos principales que envían y reciben mensajes, ya que esto puede generar amenazas de seguridad para sus enlaces de datos.

Esta operación se utiliza normalmente para generar una lista de recursos, no para ver detalles específicos.

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

list

Instance

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

Ninguna

mq:QueryInstanceBaseInfo

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Topic	string	No	Especifique el tema que desea consultar. Si deja este parámetro vacío, se consultan todos los temas.	test
InstanceId	string	No	El ID de la instancia que contiene los temas que desea consultar.	MQ_INST_188077086902****_BXSuW61e
Tag	array<object>	No	La lista de etiquetas asociadas al tema. La lista puede contener un máximo de 20 elementos.
	object	No	La estructura de la etiqueta devuelta.
Key	string	Sí	La clave de etiqueta del tema. Debe especificar los parámetros Key y Value al mismo tiempo, o dejar ambos vacíos. Si especifica ambos parámetros, esta operación consulta los temas que tienen la etiqueta especificada. Si deja ambos parámetros vacíos, esta operación consulta todos los temas. Si especifica este parámetro, su valor no puede ser una cadena vacía. El valor puede tener una longitud máxima de 128 caracteres. No puede comenzar con `aliyun` ni con `acs:`. No puede contener `http://` ni `https://`.	CartService
Value	string	Sí	El valor de etiqueta del tema. Debe especificar los parámetros Key y Value al mismo tiempo, o dejar ambos vacíos. Si especifica ambos parámetros, esta operación consulta los temas que tienen la etiqueta especificada. Si deja ambos parámetros vacíos, esta operación consulta todos los temas. Si especifica este parámetro, su valor puede ser una cadena vacía. El valor puede tener una longitud máxima de 128 caracteres. No puede comenzar con `aliyun` ni con `acs:`. No puede contener `http://` ni `https://`.	ServiceA

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La estructura de datos devuelta.
RequestId	string	Este es un parámetro común. Cada solicitud tiene un ID único. Puede utilizar este ID para solucionar problemas.	4A978869-7681-4529-B470-107E1379****
Data	object
PublishInfoDo	array<object>	La lista de temas en la instancia especificada.
	array<object>	La estructura de datos del tema devuelto.
MessageType	integer	El tipo de mensaje. Valores válidos: 0: Mensaje normal 1: Mensaje ordenado por partición 2: Mensaje ordenado globalmente 4: Mensaje transaccional 5: Mensaje programado y diferido	0
RelationName	string	El nombre de la relación. Los valores válidos son Owner, Subscribable, Publishable, y Publishable and Subscribable.	授权发布/订阅
Owner	string	El ID del propietario del tema. Este es el ID de una cuenta de Alibaba Cloud.	138015630679****
IndependentNaming	boolean	Indica si la instancia que contiene el tema tiene un espacio de nombres. Valores válidos: true: La instancia tiene un espacio de nombres independiente. El nombre del recurso debe ser único dentro de la instancia. El nombre del recurso puede ser igual al nombre de un recurso en otra instancia. false: La instancia no tiene un espacio de nombres independiente. El nombre del recurso debe ser único a nivel global, tanto dentro como entre todas las instancias.	true
Remark	string	Las observaciones.	测试
Relation	integer	El ID de la relación. Valores válidos: 1: El propietario del tema. 2: La cuenta puede publicar mensajes en el tema. 4: La cuenta puede suscribirse al tema. 6: La cuenta puede publicar mensajes en el tema y suscribirse a él.	6
CreateTime	integer	La hora en que se creó el tema.	1570700947000
Topic	string	El nombre del tema.	test
Tags	object
Tag	array<object>	Las etiquetas asociadas al tema.
	object	La definición de la estructura de la etiqueta.
Key	string	La clave de la etiqueta.	CartService
Value	string	El valor de la etiqueta.	SrviceA
InstanceId	string	El ID de la instancia que contiene el tema.	MQ_INST_188077086902****_BXSuW61e
ServiceStatus	integer	El estado de la creación asíncrona del tema. Valores válidos: 0: Creando. 1: En servicio.	0

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "4A978869-7681-4529-B470-107E1379****",
  "Data": {
    "PublishInfoDo": [
      {
        "MessageType": 0,
        "RelationName": "授权发布/订阅",
        "Owner": "138015630679****",
        "IndependentNaming": true,
        "Remark": "测试",
        "Relation": 6,
        "CreateTime": 1570700947000,
        "Topic": "test",
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "SrviceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_188077086902****_BXSuW61e",
        "ServiceStatus": 0
      }
    ]
  }
}

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.