PubBroadcast - IoT Platform - Centre de documentation Alibaba Cloud

Diffuse un message aux appareils en ligne d'un produit. Vous pouvez cibler tous les appareils en ligne ou uniquement ceux abonnés à une rubrique spécifique.

Notes d'utilisation

Définissez le paramètre TopicFullName dans la requête pour spécifier les appareils destinataires du message. Pour plus de détails, consultez la description du paramètre TopicFullName dans cette rubrique.

Limites de QPS

Vous pouvez appeler cette opération une fois par seconde et par compte pour diffuser un message aux appareils en ligne abonnés à une rubrique spécifique.
Vous pouvez appeler cette opération une fois par minute et par compte pour diffuser un message à tous les appareils en ligne d'un produit.

Remarque

Les utilisateurs RAM (Resource Access Management) d'un compte Alibaba Cloud partagent le quota de ce compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. Il génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	PubBroadcast	L'opération à effectuer. Définissez la valeur sur PubBroadcast.
MessageContent	String	Oui	aGVsbG93b3JsZA	Le contenu du message à envoyer. La taille d'un message ne doit pas dépasser 64 Ko. Pour générer le contenu du message, convertissez le message brut en données binaires puis encodez-le en Base64. Remarque IoT Platform décode les données à l'aide de l'algorithme Base64 avant d'envoyer le message décodé à l'appareil. L'appareil n'a donc pas besoin de décoder les données encodées en Base64.
ProductKey	String	Oui	aldeji3*	La ProductKey du produit auquel appartiennent les appareils. La ProductKey est un identifiant unique attribué au produit par IoT Platform. Vous pouvez consulter les informations sur tous les produits de votre compte Alibaba Cloud dans la console IoT Platform ou en appelant l'opération QueryProductList.
IotInstanceId	String	Non	iot_instc_pu*_c-v64	L'ID de l'instance. Vous pouvez consulter l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier ce paramètre. Sinon, la requête échouera. Si aucune page Overview ni aucun ID n'est généré pour votre instance, vous n'avez pas besoin de spécifier ce paramètre. Pour plus d'informations, consultez la page Overview.
TopicFullName	String	Non	/broadcast/UPqSxj2vXXX/xxx	Le nom de la rubrique. Si vous ne spécifiez pas ce paramètre, le message est envoyé à tous les appareils en ligne associés à la ProductKey indiquée. Les appareils reçoivent le message via la rubrique de diffusion au format suivant : `/sys/${productKey}/${deviceName}/broadcast/request/${MessageId}`. La variable MessageId est générée par IoT Platform. Si vous spécifiez ce paramètre, le message est envoyé aux appareils associés à la ProductKey indiquée et abonnés à la rubrique spécifiée. Vous devez définir une rubrique de diffusion en utilisant la syntaxe suivante : `/broadcast/${productKey}/Champ personnalisé`. Remplacez ${productKey} par la ProductKey des appareils destinataires. Pour le champ personnalisé, indiquez une valeur adaptée à vos besoins métier. Remarque Lors du développement des appareils, il suffit de définir une rubrique de diffusion dans le code. Aucune création de rubrique n'est nécessaire dans la console IoT Platform. Une rubrique de diffusion peut accueillir au maximum 1 000 appareils abonnés. Si ce seuil est dépassé, répartissez les appareils en groupes. Par exemple, divisez 5 000 appareils en 5 groupes de 1 000 appareils chacun. Dans ce cas, appelez l'opération PubBroadcast cinq fois. À chaque appel, définissez le champ personnalisé de la rubrique de diffusion sur group1, group2, group3, group4, puis group5. Assurez-vous que chaque groupe d'appareils s'abonne à la rubrique de diffusion correspondante.

En plus des paramètres spécifiques à cette opération, vous devez inclure les paramètres de requête communs. Pour plus d'informations, consultez les Paramètres communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de la requête. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de la requête.
MessageId	Long	1234291569964771840	L'ID du message généré par IoT Platform lors de l'envoi.
RequestId	String	BB71E443-4447-4024-A000-EDE09922891E	L'ID de la requête.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true false

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=PubBroadcast
&ProductKey=al**********
&TopicFullName=/broadcast/UPq****/xxx
&MessageContent=aGVsbG93b3JsZA
&<Common request parameters>

Exemple de réponse en cas de succès

XML format

<PubBroadcastResponse>
        <RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
        <MessageId>1234291569964771840</MessageId>
        <Success>true</Success>
  </PubBroadcastResponse>

JSON format

{
      "RequestId":"BB71E443-4447-4024-A000-EDE09922891E",
      "MessageId":1234291569964771840,
      "Success":true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.