ListRuleActions - IoT Platform - Centre de documentation Alibaba Cloud

Répertorie toutes les actions de transfert de données configurées pour une règle spécifique. Lorsque la règle est déclenchée, les données sont transférées vers différentes destinations selon les actions configurées.

Limites QPS

Chaque compte Alibaba Cloud peut exécuter jusqu'à 50 requêtes par seconde (QPS).

Remarque

Les utilisateurs Resource Access Management (RAM) 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'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type de données	Obligatoire	Exemple	Description
Action	String	Oui	ListRuleActions	Opération à effectuer. Définissez la valeur sur ListRuleActions.
RuleId	Long	Oui	10000	ID de la règle. Connectez-vous à la console IoT Platform et accédez à la page de détails de l'instance à gérer. Sur la page des détails de l'instance, choisissez Rules Engine > Data Forwarding pour obtenir l'ID de la règle. Vous pouvez également appeler l'opération ListRule pour afficher la valeur du paramètre Id dans la réponse.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	ID de l'instance. Sur la page Overview de la console IoT Platform, vous pouvez afficher l'ID de l'instance. Important Si votre instance possède un ID, vous devez spécifier cet ID pour ce paramètre. Sinon, l'appel échouera. Si la page Overview ou l'ID de l'instance n'est pas affiché dans la console IoT Platform, vous n'avez pas besoin de configurer ce paramètre. Pour plus d'informations sur l'instance, consultez la section Overview.

Outre les paramètres de requête spécifiques à l'opération précédents, vous devez spécifier 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 la section Paramètres communs.

Paramètres de réponse

Paramètre	Type de données	Exemple	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations sur les codes d'erreur, consultez la section Codes d'erreur.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	22254BDB-3DC1-4643-8D1B-EE0437EF09A9	ID de la requête.
RuleActionList	Array of RuleActionInfo		Si l'appel aboutit, toutes les actions de transfert de données configurées pour la règle spécifiée sont renvoyées. Pour plus d'informations sur les données renvoyées, consultez le paramètre RuleActionInfo ci-dessous.
RuleActionInfo
Configuration	String	{\"endPoint\":\"http://ShanghaiRegion.cn-shanghai.ots.aliyuncs.com\",\"instanceName\":\"ShanghaiRegion\",\"primaryKeys\":[{\"columnName\":\"temperature\",\"columnType\":\"INTEGER\",\"columnValue\":\"${deviceName}\"}],\"regionName\":\"cn-shanghai\",\"role\":{\"roleArn\":\"acs:ram::1231579085****:role/aliyuniotaccessingotsrole\",\"roleName\":\"AliyunIOTAccessingOTSRole\"},\"tableName\":\"iottest\",\"uid\":\"1231579085****\"}	Configurations de la destination des données.
ErrorActionFlag	Boolean	false	Indique si la destination des données est utilisée pour recevoir les données d'opération d'erreur. Les données d'opération d'erreur correspondent aux données dont le transfert a échoué deux fois consécutives. true : Cette destination est utilisée pour recevoir les données d'opération d'erreur. false : Cette destination n'est pas utilisée pour recevoir les données d'opération d'erreur.
Id	Long	139099	ID de l'action permettant de transférer les données vers la destination.
RuleId	Long	10000	ID de la règle sur laquelle repose le transfert des données vers la destination.
Status	String	NORMAL	Statut de l'action de transfert de données. Valeurs possibles : INIT : L'action est en cours de configuration. NORMAL : La configuration est terminée et l'action peut s'exécuter correctement. INVALID : Les données de configuration ne sont pas valides et l'action ne parvient pas à s'exécuter. SHORTCUT : Une exception se produit et l'action de transfert de données est arrêtée.
Type	String	OTS	Type de l'action permettant de transférer les données vers une destination. Valeurs possibles : REPUBLISH : Les données sont transférées vers un topic. OTS : Les données sont stockées dans Tablestore. MNS : Les données sont transférées vers Message Service (MNS). ONS : Les données sont transférées vers Message Queue for Apache RocketMQ. TSDB : Les données sont stockées dans Time Series Database. FC : Les données sont transférées vers Function Compute. RDS : Les données sont transférées vers ApsaraDB RDS. AMQP : Les données sont transférées vers un groupe de consommateurs Advanced Message Queuing Protocol (AMQP).
Success	Boolean	true	Indique si l'appel a réussi. true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemples de requêtes

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

Exemple de réponse réussie

Format XML

<ListRuleActionsResponse>
  <RuleActionList>
        <RuleActionInfo>
              <Type>OTS</Type>
              <RuleId>10000</RuleId>
              <Id>139099</Id>
              <Status>NORMAL</Status>
              <Configuration>{"endPoint":"http://ShanghaiRegion.cn-shanghai.ots.aliyuncs.com","instanceName":"ShanghaiRegion","primaryKeys":[{"columnName":"temperature","columnType":"INTEGER","columnValue":"${deviceName}"}],"regionName":"cn-shanghai","role":{"roleArn":"acs:ram::1231579085******:role/aliyuniotaccessingotsrole","roleName":"AliyunIOTAccessingOTSRole"},"tableName":"iottest","uid":"1231579085******"}</Configuration>
              <ErrorActionFlag>false</ErrorActionFlag>
        </RuleActionInfo>
        <RuleActionInfo>
              <Type>REPUBLISH</Type>
              <RuleId>152323</RuleId>
              <Id>142401</Id>
              <Status>NORMAL</Status>
              <Configuration>{"topic":"/sys/a1zSA28H***/device/thing/service/property/set","topicType":0,"uid":"1231579085******"}</Configuration>
              <ErrorActionFlag>false</ErrorActionFlag>
        </RuleActionInfo>
  </RuleActionList>
  <RequestId>22254BDB-3DC1-4643-8D1B-EE0437EF09A9</RequestId>
  <Success>true</Success>
</ListRuleActionsResponse>

Format JSON

{
  "RuleActionList": {
    "RuleActionInfo": [
      {
        "Type": "OTS", 
        "RuleId": 10000, 
        "Id": 139099, 
        "Status":"NORMAL",
        "Configuration": "{\"endPoint\":\"http://ShanghaiRegion.cn-shanghai.ots.aliyuncs.com\",\"instanceName\":\"ShanghaiRegion\",\"primaryKeys\":[{\"columnName\":\"temperature\",\"columnType\":\"INTEGER\",\"columnValue\":\"${deviceName}\"}],\"regionName\":\"cn-shanghai\",\"role\":{\"roleArn\":\"acs:ram::1231579085******:role/aliyuniotaccessingotsrole\",\"roleName\":\"AliyunIOTAccessingOTSRole\"},\"tableName\":\"iottest\",\"uid\":\"1231579085******\"}", 
        "ErrorActionFlag": false
      }, 
      {
        "Type": "REPUBLISH", 
        "RuleId": 152323, 
        "Id": 142401, 
        "Status": "NORMAL",
        "Configuration": "{\"topic\":\"/sys/a1zSA28H***/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579085******\"}", 
        "ErrorActionFlag": false
      }
    ]
  }, 
  "RequestId": "22254BDB-3DC1-4643-8D1B-EE0437EF09A9", 
  "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs.