GetRule - Query rule details | IoT Platform - IoT Platform - Centre de documentation Alibaba Cloud

Limites

Maximum : 50 QPS par compte Alibaba Cloud.

Remarque

Les utilisateurs RAM partagent le quota du compte.

Débogage

OpenAPI Explorer calcule automatiquement les signatures et génère des exemples de code SDK. Nous vous recommandons d'appeler cette opération via OpenAPI Explorer.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	GetRule	Opération à effectuer. Définissez la valeur sur GetRule.
RuleId	Long	Oui	100000	ID de la règle. Retrouvez-le dans la console IoT Platform sous Rules > Data Forwarding, ou appelez l'opération ListRule.
IotInstanceId	String	Non	iot-cn-0pp1n8t****	ID de l'instance. Consultez l'ID sur la page Overview de la console IoT Platform. Important Obligatoire si votre instance possède un ID. L'appel échoue en l'absence de cet ID. Non requis si votre instance ne possède pas de page Overview ou d'ID. Overview.

Vous devez également spécifier les paramètres de requête communs lors de l'appel de cette opération.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Consultez les Codes d'erreur.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	58D4CEC0-3E95-4DBE-AFC1-809D1400E52F	ID de la requête.
RuleInfo	Struct		Détails de la règle renvoyés en cas de succès.
CreateUserId	Long	100000000000000	ID de l'utilisateur ayant créé la règle.
Created	String	Thu Feb 28 14:14:33 CST 2019	Heure de création (UTC-6).
DataType	String	JSON	Type de données de la règle. Valeurs possibles : JSON et BINARY.
Id	Long	100000	ID de la règle.
Modified	String	Thu Feb 28 14:20:58 CST 2019	Heure de la dernière modification (UTC-6).
Name	String	iotrules	Nom de la règle.
ProductKey	String	a1KiV******	ProductKey du produit auquel s'applique la règle.
RuleDesc	String	rule1Desc	Description de la règle.
Select	String	deviceName() as deviceName	Clause Select de l'instruction SQL de la règle.
ShortTopic	String	+/user/pm25data	Rubrique (topic) à laquelle s'applique la règle, hors niveau ProductKey. Format : `${deviceName}/topicShortName`. ${deviceName} correspond au nom de l'appareil et topicShortName au nom personnalisé de la rubrique. Remarque Les caractères génériques `+` et `#` sont décrits dans la section Caractères génériques des rubriques.
Status	String	STOP	Statut de la règle. Valeurs possibles : RUNNING : En cours d'exécution STOP : Arrêté
Topic	String	/a1QsMlL44pp/+/user/pm25data	Rubrique (topic) complète à laquelle s'applique la règle. Format : `${productKey}/${deviceName}/topicShortName`. Remarque Les caractères génériques `+` et `#` sont décrits dans la section Caractères génériques des rubriques.
TopicType	Integer	1	Type de rubrique. Renvoyé uniquement si la règle contient une instruction SQL. Valeurs possibles : 0 : Rubrique de communication de base ou rubrique de communication TSL. 1 : Rubrique personnalisée. 2 : Rubrique d'état de l'appareil. Renvoie -1 si aucune instruction SQL n'est définie.
UtcCreated	String	2019-02-28T06:14:33.000Z	Heure de création (UTC).
UtcModified	String	2019-02-28T06:20:58.000Z	Heure de la dernière modification (UTC).
Where	String	Temperature>35	Clause Where de l'instruction SQL de la règle.
Success	Boolean	true	Indique si l'appel a réussi. true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=GetRule
&RuleId=100000
&<Common request parameters>

Exemple de réponse réussie

Format XML

<GetRuleResponse>
  <RequestId>85648524-E5EE-418E-BD16-FAFBB4FF3645</RequestId>
  <Success>true</Success>
  <RuleInfo>
        <DataType>JSON</DataType>
        <ShortTopic>+/user/pm25data</ShortTopic>
        <ProductKey>a1QsMl****</ProductKey>
        <UtcModified>2019-12-23T03:34:45.000Z</UtcModified>
        <CreateUserId>198426864326****</CreateUserId>
        <UtcCreated>2019-12-23T02:32:06.000Z</UtcCreated>
        <Name>Ruff_rule1</Name>
        <Status>RUNNING</Status>
        <Select>deviceName() as deviceName , timestamp('yyyy-MM-dd HH:mm:ss') as time, pm25, pm10</Select>
        <Created>Mon Dec 23 10:32:06 CST 2019</Created>
        <Modified>Mon Dec 23 11:34:45 CST 2019</Modified>
        <TopicType>1</TopicType>
        <Topic>/a1QsMlL****/+/user/pm25data</Topic>
        <Id>425367</Id>
  </RuleInfo>
</GetRuleResponse>

Format JSON

{
    "RequestId": "85648524-E5EE-418E-BD16-FAFBB4FF3645",
    "Success": true,
    "RuleInfo": {
        "DataType": "JSON",
        "ShortTopic": "+/user/pm25data",
        "ProductKey": "a1QsMl****",
        "UtcModified": "2019-12-23T03:34:45.000Z",
        "CreateUserId": "198426864326****",
        "UtcCreated": "2019-12-23T02:32:06.000Z",
        "Name": "Ruff_rule1",
        "Status": "RUNNING",
        "Select": "deviceName() as deviceName , timestamp('yyyy-MM-dd HH:mm:ss') as time, pm25, pm10",
        "Created": "Mon Dec 23 10:32:06 CST 2019",
        "Modified": "Mon Dec 23 11:34:45 CST 2019",
        "TopicType": 1,
        "Topic": "/a1QsMlL****/+/user/pm25data",
        "Id": 425367
    }
}

Codes d'erreur

Tous les codes d'erreur sont répertoriés dans le Centre d'erreurs API.