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

Suscribe un dispositivo específico a uno o más topics.

Notas de uso

El dispositivo debe estar conectado a IoT Platform y en línea.
Cada llamada suscribe los topics de un solo dispositivo. Especifique hasta 10 topics por llamada.

Límites de QPS

Cada cuenta de Alibaba Cloud puede llamar a esta operación hasta 10 veces por segundo (QPS).

Nota

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

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	SubscribeTopic	La operación que desea ejecutar. Establezca el valor en SubscribeTopic.
DeviceName	String	Sí	device1	El DeviceName del dispositivo al que pertenece el topic.
ProductKey	String	Sí	a1Q5XoY***	El ProductKey del producto al que pertenece el dispositivo.
Topic.N	RepeatList	Sí	/a1Q5XoY***/device1/user/get	Los topics a los que desea suscribirse. Especifique hasta 10 topics. Los topics deben contar con los permisos Subscribe o Publish and Subscribe.
IotInstanceId	String	No	iot-06***	El ID de la instancia. Consulte el ID en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, especifique este parámetro. De lo contrario, la llamada fallará. Si no se generó ninguna página Overview ni ningún ID para su instancia, no es necesario especificar este parámetro. Para obtener más información, consulte Descripción general.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, también debe especificar los parámetros de solicitud comunes. Para obtener más información, consulte Parámetros de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error. Para obtener más información, consulte Códigos de error.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	BB71E443-4447-4024-A000-EDE09922891E	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: la llamada fue exitosa. false: la llamada finalizó con errores.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=SubscribeTopic
&DeviceName=device1
&ProductKey=a1Q5XoY***
&Topic.1=/a1Q5XoY***/device1/user/get
&Topic.2=/a1Q5XoY***/device1/user/add
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<SubscribeTopicResponse>
  <RequestId>32B9828A-25DD-48E2-8E26-D1664B341940</RequestId>
  <Success>true</Success>
</SubscribeTopicResponse>

Formato JSON

{
    "RequestId": "32B9828A-25DD-48E2-8E26-D1664B341940",
    "Success": true
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
500	Iot.MessageBroker.BatchSubTopicFailed	An error occurred while batch subscribing to the topic.	Mensaje de error devuelto porque la suscripción por lotes falló.
400	Iot.System.BillIsOverDue	Your account has overdue payments. Go to the expense center and add funds to your account.	Mensaje de error devuelto porque tiene pagos pendientes. Vaya al centro de cuentas y agregue fondos a su cuenta.
400	Iot.MessageBroker.EmptySubTopicList	The subscription topic list is empty.	Mensaje de error devuelto porque la lista de topics está vacía.
400	Iot.Device.NotExistedDevice	The device does not exist.	Mensaje de error devuelto porque el dispositivo no existe o no está activado.
403	Iot.Device.NotDeviceOwner	You are not the device owner.	Mensaje de error devuelto porque el operador actual no es el propietario del dispositivo.
400	Iot.MessageBroker.TopicTemplateIsNotFound	The topic template does not exist.	Mensaje de error devuelto porque la plantilla especificada no existe.
400	iot.prod.NotExistedProduct	The specified product does not exist.	Mensaje de error devuelto porque el producto especificado no existe.
400	iot.device.InactiveDevice	The device is inactive.	Mensaje de error devuelto porque el dispositivo no está activado. Esto indica que el dispositivo nunca se ha conectado a IoT Platform.

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