GetRuleAction - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta la información detallada de una acción de regla específica.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 50 consultas por segundo (QPS).

Nota

Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

Alibaba Cloud ofrece OpenAPI Explorer para simplificar el uso de la API. OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	GetRuleAction	La operación que desea ejecutar. Establezca el valor en GetRuleAction.
ActionId	Long	Sí	100001	El ID de la acción de regla que desea consultar. Puede obtener el ID de la acción de regla mediante los siguientes métodos: Llame a la operación CreateRuleAction y consulte el parámetro ActionId en la respuesta. Llame a la operación ListRuleActions y consulte el parámetro Id en la respuesta.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, configure este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene una página Overview o ID, omita este parámetro. Para más información, consulte Descripción general.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, especifique los parámetros de solicitud comunes al llamar a esta operación. Para más información, consulte Parámetros de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para más información, consulte Códigos de error.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	F2D0755D-F350-40FE-9A6D-491859DB5E5F	El ID de la solicitud.
RuleActionInfo	Struct		La información de la acción de regla devuelta si la llamada fue exitosa. Para más información, consulte los siguientes parámetros.
Configuration	String	{\"topic\":\"/sys/a1zSA28**/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579*****\"}	La configuración de la acción de regla.
ErrorActionFlag	Boolean	false	Indica si la acción de regla reenvió datos de operaciones con errores que no pudieron reenviarse al servicio en la nube de destino. Un fallo en el reenvío de datos indica que los reintentos también fallaron. true: reenvía datos de operaciones con errores. false: reenvía datos normales en lugar de datos de operaciones con errores.
Id	Long	100001	El ID de la acción de regla.
RuleId	Long	152323	El ID de la regla asociada a la acción de regla.
Type	String	REPUBLISH	El tipo de la acción de regla. Valores válidos: REPUBLISH: reenvía datos a otro tema. OTS: almacena datos en Tablestore. MNS: envía datos a Message Service (MNS). FC: envía datos a Function Compute. RDS: guarda en bases de datos en la nube. AMQP: reenvía datos a un grupo de consumidores AMQP.
Success	Boolean	true	Indica si la llamada fue exitosa. true: la llamada fue exitosa. false: la llamada falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=GetRuleAction
&ActionId=1000001
&<Common request parameters>

Respuestas exitosas de ejemplo

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

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

Códigos de error

Para consultar la lista de códigos de error, visite el Centro de errores de API.