GetRuleAction - IoT Platform - Centre de documentation Alibaba Cloud

Renvoie les informations détaillées d’une action de règle spécifiée.

Limites

Chaque compte Alibaba Cloud est limité à 50 requêtes par seconde (QPS).

Remarque

Les utilisateurs RAM d’un compte Alibaba Cloud partagent le quota de ce compte.

Débogage

Alibaba Cloud met à votre disposition OpenAPI Explorer pour simplifier l’utilisation des API. 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	Obligatoire	Exemple	Description
Action	String	Oui	GetRuleAction	Opération à effectuer. Définissez la valeur sur GetRuleAction.
ActionId	Long	Oui	100001	ID de l’action de règle à interroger. Pour obtenir l’ID de l’action de règle, procédez comme suit : Appelez l’opération CreateRuleAction et consultez le paramètre ActionId dans la réponse. Appelez l’opération ListRuleActions et consultez le paramètre Id dans la réponse.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	ID de l’instance. Vous pouvez consulter l’ID de l’instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez renseigner ce paramètre. À défaut, l’appel échoue. Si votre instance ne possède pas de page Overview ni d’ID, il n’est pas nécessaire de définir ce paramètre. Pour plus d’informations, consultez la rubrique Overview.

Outre les paramètres de requête spécifiques à l’opération présentés ci-dessus, vous devez spécifier les paramètres de requête communs lors de l’appel à cette opération. Pour plus d’informations, consultez la rubrique Paramètres de requête communs.

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. Pour plus d’informations, consultez la rubrique Codes d’erreur.
ErrorMessage	String	A system exception occurred.	Message d’erreur renvoyé en cas d’échec de l’appel.
RequestId	String	F2D0755D-F350-40FE-9A6D-491859DB5E5F	ID de la requête.
RuleActionInfo	Struct		Informations relatives à l’action de règle renvoyées en cas de succès de l’appel. Consultez les paramètres suivants pour plus de détails.
Configuration	String	{\"topic\":\"/sys/a1zSA28**/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579*****\"}	Configurations de l’action de règle.
ErrorActionFlag	Boolean	false	Indique si l’action de règle a transféré les données d’opération en erreur qui n’ont pas pu être envoyées au service cloud de destination. Un échec de transfert des données signifie que les nouvelles tentatives ont également échoué. true : transfère les données d’opération en erreur. false : transfère les données normales au lieu des données d’opération en erreur.
Id	Long	100001	ID de l’action de règle.
RuleId	Long	152323	ID de la règle associée à l’action de règle.
Type	String	REPUBLISH	Type de l’action de règle. Valeurs possibles : REPUBLISH : transfère les données vers un autre topic. OTS : stocke les données dans Tablestore. MNS : envoie les données à Message Service (MNS). FC : envoie les données à Function Compute. RDS : enregistre dans des bases de données cloud. AMQP : transfère les données à un groupe de consommateurs 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=GetRuleAction
&ActionId=1000001
&<Common request parameters>

Exemples de réponses réussies

Format XML

<GetRuleActionResponse>
      <RuleActionInfo>
            <Type>REPUBLISH</Type>
            <RuleId>152323</RuleId>
            <Id>100001</Id>
            <Configuration>
                  <topic>/sys/a1zSA28****/device/thing/service/property/set</topic>
                  <topicType>0</topicType>
                  <uid>1231579*******</uid>
            </Configuration>
            <ErrorActionFlag>false</ErrorActionFlag>
      </RuleActionInfo>
      <RequestId>F2D0755D-F350-40FE-9A6D-491859DB5E5F</RequestId>
      <Success>true</Success>
</GetRuleActionResponse>

Format JSON

{
  "RuleActionInfo": {
    "Type": "REPUBLISH", 
    "RuleId": 152323, 
    "Id": 100001, 
    "Configuration": "{\"topic\":\"/sys/a1zSA28***/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579*******\"}", 
    "ErrorActionFlag": false
  }, 
  "RequestId": "F2D0755D-F350-40FE-9A6D-491859DB5E5F", 
  "Success": true
}

Codes d’erreur

Pour obtenir la liste des codes d’erreur, visitez le Centre d’erreurs API.