OnsTopicList - - Centro de documentación de Alibaba Cloud

Consulta la información de los topics a los que tiene acceso la cuenta actual.

Notas de uso

Esta operación devuelve la información básica de los topics, pero no incluye sus detalles.

Límite de solicitudes

Cada cuenta de Alibaba Cloud puede invocar esta operación hasta 10 veces por segundo. Si el número de solicitudes enviadas en un segundo alcanza este límite, las nuevas solicitudes fallarán, lo cual podría interrumpir su servicio. Para obtener más información sobre los límites de cada operación, consulte Límites de velocidad de la API.

Autorización

De forma predeterminada, solo las cuentas de Alibaba Cloud pueden invocar esta operación. Un usuario de Resource Access Management (RAM) solo podrá hacerlo si se le han otorgado los permisos obligatorios. La siguiente tabla describe los permisos que debe asignar al usuario de RAM para que pueda ejecutar esta operación.

API	Action	Resource
OnsTopicList	mq:QueryInstanceBaseInfo	acs:mq:::{instanceId}

Nota

Si utiliza la credencial de un usuario de RAM para invocar esta operación, el sistema devolverá únicamente la información de los topics sobre los cuales dicho usuario tenga los permisos correspondientes. Para acceder a otros topics, inicie sesión en la consola de RAM con su cuenta de Alibaba Cloud y asigne al usuario de RAM los permisos necesarios sobre los topics deseados. Para más información sobre cómo otorgar permisos, consulte

Directivas y ejemplos

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	OnsTopicList	La operación que desea realizar. Establezca el valor en OnsTopicList.
Topic	String	No	test	Nombre del topic que desea consultar. Este parámetro es obligatorio cuando busca un topic específico. Si no lo incluye en la solicitud, se consultarán todos los topics a los que tenga acceso.
InstanceId	String	Sí	MQ_INST_188077086902****_BXSuW61e	ID de la instancia de Message Queue for Apache RocketMQ que contiene los topics que desea consultar.
Tag.N.Key	String	Sí	CartService	Clave de una etiqueta asociada a los topics que desea consultar. Este parámetro no es obligatorio; sin embargo, si lo configura, también debe especificar el parámetro Tag.N.Value. Si incluye Tag.N.Key y Tag.N.Value en la solicitud, la operación consultará únicamente los topics que utilicen dichas etiquetas. De lo contrario, se consultarán todos los topics accesibles. El valor de N debe ser un número entero entre 1 y 20. Si incluye este parámetro en la solicitud, su valor no puede ser una cadena vacía. El valor debe tener una longitud máxima de 128 caracteres y no puede comenzar con acs: ni aliyun, ni contener http:// o https://.
Tag.N.Value	String	Sí	ServiceA	Valor de una etiqueta asociada a los topics que desea consultar. Este parámetro no es obligatorio; sin embargo, si lo configura, también debe especificar el parámetro Tag.N.Key. Si incluye Tag.N.Key y Tag.N.Value en la solicitud, la operación consultará únicamente los topics que utilicen dichas etiquetas. De lo contrario, se consultarán todos los topics accesibles. El valor de N debe ser un número entero entre 1 y 20. El valor de este parámetro puede ser una cadena vacía. El valor debe tener una longitud máxima de 128 caracteres y no puede comenzar con acs: ni aliyun, ni contener http:// o https://.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	4A978869-7681-4529-B470-107E1379****	ID de la solicitud. El sistema genera un identificador único para cada solicitud, el cual puede utilizar para solucionar problemas.
Data	Array of PublishInfoDo		Lista de topics.
PublishInfoDo
MessageType	Integer	0	Tipo de mensaje. Valores válidos: 0: mensajes normales 1: mensajes ordenados por partición 2: mensajes ordenados globalmente 4: mensajes transaccionales 5: mensajes programados o diferidos
RelationName	String	Publish and subscribe	Nombre de la relación entre la cuenta actual y el topic. Este valor indica si la cuenta actual es propietaria del topic, si puede publicar mensajes, si puede suscribirse, o si tiene capacidad tanto para publicar como para suscribirse.
Owner	String	138015630679****	ID de usuario del propietario del topic.
IndependentNaming	Boolean	true	Indica si la instancia de Message Queue for Apache RocketMQ que contiene el topic utiliza un namespace. Valores válidos: true: la instancia utiliza un namespace. El identificador de cada recurso debe ser único dentro de la instancia, aunque puede coincidir con el de otro recurso en una instancia distinta que use un namespace diferente. false: la instancia no utiliza un namespace. El identificador de cada recurso debe ser único en todas las instancias.
Remark	String	Test	Descripción del topic.
Relation	Integer	6	Indica la relación entre la cuenta actual y el topic. Valores válidos: 1: la cuenta actual es propietaria del topic. 2: la cuenta actual puede publicar mensajes en el topic. 4: la cuenta actual puede suscribirse al topic. 6: la cuenta actual puede publicar mensajes y suscribirse al topic.
CreateTime	Long	1570700947000	Momento en que se creó el topic.
Topic	String	test	Nombre del topic.
Tags	Array of Tag		Etiquetas asociadas al topic.
Tag
Key	String	CartService	Clave de la etiqueta.
Value	String	SrviceA	Valor de la etiqueta.
InstanceId	String	MQ_INST_188077086902****_BXSuW61e	ID de la instancia de Message Queue for Apache RocketMQ que contiene el topic.
ServiceStatus	Integer	0	Estado del topic. Valores válidos: 0: el topic se está creando. 1: el topic está en servicio.

Ejemplos

Solicitudes de ejemplo

http(s)://ons.cn-zhangjiakou.aliyuncs.com/?Action=OnsTopicList
&InstanceId=MQ_INST_188077086902****_BXSuW61e
&Tag.1.Key=CartService
&Tag.1.Value=ServiceA
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsTopicListResponse>
    <RequestId>4A978869-7681-4529-B470-107E1379****</RequestId>
    <Data>
        <MessageType>0</MessageType>
        <RelationName>Publish and subscribe</RelationName>
        <Owner>138015630679****</Owner>
        <IndependentNaming>true</IndependentNaming>
        <Remark>Test</Remark>
        <Relation>6</Relation>
        <CreateTime>1570700947000</CreateTime>
        <Topic>test</Topic>
        <Tags>
            <Key>CartService</Key>
            <Value>SrviceA</Value>
        </Tags>
        <InstanceId>MQ_INST_188077086902****_BXSuW61e</InstanceId>
        <ServiceStatus>0</ServiceStatus>
    </Data>
</OnsTopicListResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4A978869-7681-4529-B470-107E1379****",
  "Data" : [ {
    "MessageType" : 0,
    "RelationName": "Publish and subscribe",
    "Owner" : "138015630679****",
    "IndependentNaming" : true,
    "Remark": "Test",
    "Relation" : 6,
    "CreateTime" : 1570700947000,
    "Topic" : "test",
    "Tags" : [ {
      "Key" : "CartService",
      "Value" : "SrviceA"
    } ],
    "InstanceId" : "MQ_INST_188077086902****_BXSuW61e",
    "ServiceStatus" : 0
  } ]
}

Códigos de error

Para consultar la lista de códigos de error, visite el Centro de errores de la API.