CreateProductTopic - IoT Platform - Centre de documentation Alibaba Cloud

Limites QPS

Vous pouvez appeler cette opération une fois par seconde et 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	CreateProductTopic	L'action que vous souhaitez effectuer. Définissez la valeur sur CreateProductTopic.
Operation	String	Yes	PUB	Les permissions d'un appareil sur la catégorie de rubrique personnalisée. Valeurs valides : SUB : S'abonner. PUB : Publier. ALL : Publier et s'abonner.
ProductKey	String	Yes	aldDEin****	La ProductKey du produit pour lequel vous souhaitez créer la catégorie de rubrique personnalisée.
TopicShortName	String	Yes	submit	Le nom de la catégorie de rubrique personnalisée. Une catégorie de rubrique est composée de plusieurs champs. Séparez les champs par des barres obliques (`/`). Le nom peut contenir des lettres, des chiffres et des traits de soulignement (_). Chaque niveau de nom de la catégorie de rubrique ne doit pas être vide. Remarque Si vous définissez Operation sur SUB, vous pouvez spécifier les caractères génériques signe plus (`+`) et dièse (`#`) dans le nom d'une catégorie de rubrique pour permettre aux appareils de s'abonner à plusieurs rubriques à la fois. Pour plus d'informations sur l'utilisation des caractères génériques, consultez Rubriques personnalisées avec caractères génériques. Si vous utilisez un produit de passerelle cloud, aucun préfixe n'est spécifié automatiquement. Vous devez spécifier une valeur personnalisée pour le paramètre. Vous pouvez utiliser `${deviceName}` pour spécifier un DeviceName. Si vous utilisez un produit autre qu'une passerelle cloud, `/${productKey}/${deviceName}/user/` est automatiquement spécifié comme préfixe de la valeur de TopicShortName. Il vous suffit de spécifier un nom personnalisé pour la catégorie de rubrique.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	L'ID de l'instance. Vous pouvez afficher 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 échouera. 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 Vue d'ensemble.
Desc	String	No	submit a test topic	La description de la catégorie de rubrique personnalisée. La description peut comporter jusqu'à 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	Indique 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 Compression des données. Important Si vous spécifiez une valeur contenant des caractères génériques, y compris le signe plus (`+`) et le dièse (`#`), 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, l'appel échoue.

En plus des paramètres de requête spécifiques à l'opération mentionnés ci-dessus, vous devez configurer les 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 Paramètres communs.

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 Codes d'erreur.
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é.
TopicId	Long	10000	L'ID de la catégorie de rubrique personnalisée. L'ID est émis par IoT Platform si l'appel réussit. Remarque Gardez l'ID de la catégorie de rubrique personnalisée confidentiel. L'ID de la catégorie de rubrique personnalisée est requis lors de l'appel de certaines opérations liées à la catégorie de rubrique personnalisée.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProductTopic
&ProductKey=aldDEin****
&TopicShortName=submit
&Operation=PUB
&Desc=submit a test topic
&<Common request parameters>

Exemples de réponses réussies

XML format

<CreateProductTopicResponse>
      <RequestId>FCC27691-9151-4B93-9622-9C90F30542EC</RequestId>
      <Success>true</Success>
      <TopicId>10000</TopicId>
</CreateProductTopicResponse>

JSON format

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

Codes d'erreur

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