UpdateProductTopic - IoT Platform - Centre de documentation Alibaba Cloud

Limites de QPS

Vous pouvez appeler cette opération d'API jusqu'à 50 fois par seconde par compte.

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	UpdateProductTopic	L'opération que vous souhaitez effectuer. Définissez la valeur sur UpdateProductTopic.
Operation	String	Yes	PUB	Les permissions de l'appareil sur la catégorie de rubrique. Valeurs valides : SUB : S'abonner. PUB : Publier ALL : Publier et s'abonner
TopicId	String	Yes	821****	L'ID de la catégorie de rubrique que vous souhaitez modifier. Si une catégorie de rubrique personnalisée est créée après avoir appelé l'opération CreateProductTopic, l'ID de la catégorie de rubrique indiqué par TopicId est renvoyé.
TopicShortName	String	Yes	resubmit	Le nom du niveau de catégorie personnalisé. Par défaut, une catégorie de rubrique comprend les niveaux suivants : _productkey_ et _devicename_. Séparez les deux niveaux par des barres obliques (/). Format d'une catégorie de rubrique : `productKey/deviceName/topicShortName`. Remarque Chaque niveau peut contenir des lettres, des chiffres et des traits de soulignement (_), et ne peut pas être vide.
IotInstanceId	String	Optional	iot_instc_pu***_c-v64********	L'ID de l'instance. Vous pouvez obtenir l'ID de l'instance dans l'onglet Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier l'ID pour ce paramètre. Sinon, l'appel échoue. Si votre instance ne possède pas d'ID, vous n'avez pas besoin de configurer le paramètre. Pour plus d'informations sur les instances, consultez Overview.
Desc	String	No	resubmit a test topic	La description de la catégorie de rubrique. La description doit comporter entre 1 et 100 caractères.
EnableProxySubscribe	Boolean	No	false	Si vous définissez Operation sur SUB ou ALL, vous pouvez activer la fonctionnalité d'abonnement délégué. Valeurs valides : true : active la fonctionnalité d'abonnement délégué. false : désactive la fonctionnalité d'abonnement délégué. Si vous activez la fonctionnalité d'abonnement délégué pour une rubrique, IoT Platform obtient les détails de la rubrique et aide un appareil à s'abonner à la rubrique lorsque vous connectez l'appareil à IoT Platform.
Codec	String	No	compress	Spécifie s'il faut activer la fonctionnalité de compression ou de décompression des données pour une rubrique personnalisée. Ce paramètre est disponible uniquement si vous utilisez une instance Enterprise Edition Standard ou Exclusive. Valeurs valides : compress : active la compression des données. decompress : active la décompression des données. Pour plus d'informations, consultez Data compression. Important Si vous spécifiez une valeur qui inclut des caractères génériques (`+`et `#`) pour TopicShortName, vous ne pouvez pas configurer Codec. Si la fonctionnalité de compression ou de décompression des données est activée lors de la création d'une catégorie de rubrique à l'aide de caractères génériques, cette requête échoue.

En plus des paramètres de requête spécifiques à l'opération ci-dessus, vous devez spécifier des paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations sur les paramètres de requête communs, consultez Common parameters.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez Error codes.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	FCC27691-9151-4B93-9622-9C90F30542EC	L'ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. Valeurs valides : true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateProductTopic
&TopicId=821****
&TopicShortName=resubmit
&Operation=PUB
&Desc=resubmit a test topic
&<Common request parameters>

Exemples de réponses réussies

XML format

<UpdateProductTopicResponse>
      <RequestId>FCC27691-9151-4B93-9622-9C90F30542EC</RequestId>
      <Success>true</Success>
</UpdateProductTopicResponse>

JSON format

{
    "RequestId":"FCC27691-9151-4B93-9622-9C90F30542EC",
    "Success":true
}

Codes d'erreur

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