QueryProductTopic - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta los detalles de las categorías de topics personalizados de un producto.

Límites de QPS

Puede llamar a esta operación de API hasta tres veces por segundo por cuenta.

Nota

Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryProductTopic	La operación que desea ejecutar. Establezca el valor en QueryProductTopic.
ProductKey	String	Sí	HMyB*******	El ProductKey del producto.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Puede obtener el ID de la instancia en la página Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe configurar este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene un ID, no es necesario configurar este parámetro. Para más información, consulte Descripción general de la instancia.

Además de los parámetros de solicitud específicos de la operación anteriores, debe especificar los parámetros de solicitud comunes al llamar a esta operación. Para más información, consulte Common parameters.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para más información, consulte Error codes.
Data	Array of ProductTopicInfo		Las categorías de topics personalizados devueltas si la llamada es exitosa. Para más información, consulte ProductTopicInfo.
ProductTopicInfo
Codec	String	compress	Indica si la función de compresión o descompresión de datos está habilitada para la categoría de topic personalizado. Valores válidos: compress: La función de compresión de datos está habilitada. decompress: La función de descompresión de datos está habilitada. Para más información, consulte Data compression.
Desc	String	topicDesc	La descripción de la categoría de topic personalizado.
EnableProxySubscribe	Boolean	false	Indica si la función de suscripción delegada está habilitada. Valores válidos: true: La función de suscripción delegada está habilitada. false: La función de suscripción delegada está deshabilitada. Si habilita la función de suscripción delegada para un topic, IoT Platform obtiene los detalles del topic y ayuda a un dispositivo a suscribirse al topic cuando conecta el dispositivo a IoT Platform.
Id	String	821****	El ID de la categoría de topic personalizado.
Operation	String	1	Los permisos que desea otorgar al dispositivo sobre la categoría de topic personalizado. Valores válidos: 0: Publicar. 1: Suscribirse. 2: Publicar y suscribirse.
ProductKey	String	HMyB***	El ProductKey del producto.
TopicShortName	String	/HMyB***/${deviceName}/user/get	El nombre de la categoría de topic personalizado.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	B953EAFF-CFF6-4FF8-BC94-8B89F018E4DD	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. Valores válidos: true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProductTopic
&ProductKey=HMyB*******
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryProductTopicResponse>
  <RequestId>310E4A1E-B614-5607-B7DB-55530CAE074A</RequestId>
  <Data>
        <ProductTopicInfo>
              <TopicShortName>/g18******F/${deviceName}/user/get</TopicShortName>
              <EnableProxySubscribe>false</EnableProxySubscribe>
              <Operation>1</Operation>
              <Id>3679****</Id>
              <ProductKey>g18******F</ProductKey>
        </ProductTopicInfo>
        <ProductTopicInfo>
              <TopicShortName>/g18******F/${deviceName}/user/update</TopicShortName>
              <EnableProxySubscribe>false</EnableProxySubscribe>
              <Operation>0</Operation>
              <Id>3679****</Id>
              <ProductKey>g18******F</ProductKey>
        </ProductTopicInfo>
        <ProductTopicInfo>
              <TopicShortName>/g18******F/${deviceName}/user/update/error</TopicShortName>
              <EnableProxySubscribe>false</EnableProxySubscribe>
              <Operation>0</Operation>
              <Id>3679****</Id>
              <ProductKey>g18******F</ProductKey>
        </ProductTopicInfo>
  </Data>
  <Success>true</Success>
</QueryProductTopicResponse>

Formato JSON

{
    "RequestId": "310E4A1E-B614-5607-B7DB-55530CAE074A",
    "Data": {
        "ProductTopicInfo": [
            {
                "TopicShortName": "/g18******F/${deviceName}/user/get",
                "EnableProxySubscribe": false,
                "Operation": "1",
                "Id": "3679****",
                "ProductKey": "g18******F"
            },
            {
                "TopicShortName": "/g18******F/${deviceName}/user/update",
                "EnableProxySubscribe": false,
                "Operation": "0",
                "Id": "3679****",
                "ProductKey": "g18******F"
            },
            {
                "TopicShortName": "/g18******F/${deviceName}/user/update/error",
                "EnableProxySubscribe": false,
                "Operation": "0",
                "Id": "3679****",
                "ProductKey": "g18******F"
            }
        ]
    },
    "Success": true
}

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.