QueryProductTopic - IoT Platform - Centre de documentation Alibaba Cloud

Limites QPS

Vous pouvez appeler cette opération d'API jusqu'à trois 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 la signature. Pour plus de simplicité, 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 la requête

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryProductTopic	L'opération que vous souhaitez effectuer. Définissez la valeur sur QueryProductTopic.
ProductKey	String	Yes	HMyB*******	La ProductKey du produit.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	L'ID de l'instance. Vous pouvez obtenir l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. Sinon, l'appel échouera. Si votre instance ne possède pas d'ID, vous n'avez pas besoin de configurer ce paramètre. Pour plus d'informations, consultez Présentation des instances.

Outre les paramètres de requête spécifiques à l'opération mentionnés ci-dessus, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, 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.
Data	Array of ProductTopicInfo		Les catégories de rubrique personnalisées renvoyées en cas de réussite de l'appel. Pour plus d'informations, consultez ProductTopicInfo.
ProductTopicInfo
Codec	String	compress	Indique si la fonctionnalité de compression ou de décompression des données est activée pour la catégorie de rubrique personnalisée. Valeurs possibles : compress : La fonctionnalité de compression des données est activée. decompress : La fonctionnalité de décompression des données est activée. Pour plus d'informations, consultez Compression des données.
Desc	String	topicDesc	La description de la catégorie de rubrique personnalisée.
EnableProxySubscribe	Boolean	false	Indique si la fonctionnalité d'abonnement délégué est activée. Valeurs possibles : true : La fonctionnalité d'abonnement délégué est activée. false : La fonctionnalité d'abonnement délégué est désactivée. 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.
Id	String	821****	L'ID de la catégorie de rubrique personnalisée.
Operation	String	1	Les permissions que vous souhaitez accorder à l'appareil sur la catégorie de rubrique personnalisée. Valeurs possibles : 0 : Publication. 1 : Abonnement. 2 : Publication et abonnement.
ProductKey	String	HMyB***	La ProductKey du produit.
TopicShortName	String	/HMyB***/${deviceName}/user/get	Le nom de la catégorie de rubrique personnalisée.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	B953EAFF-CFF6-4FF8-BC94-8B89F018E4DD	L'ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. Valeurs possibles : true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

Format 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>

Format 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
}

Codes d'erreur

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