Call this operation to query the information of a specified rule action.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to GetRuleAction.
ActionId Long Yes The ID of the rule action that you want to query.
Common request parameters - Yes See Common parameters.

Response parameters

Parameter Type Description
RequestId String The globally unique ID generated by Alibaba Cloud for the request.
Success Boolean Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call has failed.
ErrorMessage String The error message returned when the call fails.
Code String The error code returned when the call fails. For more information about error codes, see Error codes.
RuleActionInfo RuleActionInfo The details of the rule action returned when the call is successful. See the following table RuleActionInfo.
Table 1. RuleActionInfo
Parameter Type Description
Id Long The ID of the rule action.
RuleId Long The ID of the rule that this rule action belongs to.
Type String

The rule action type which indicates the data forwarding target of this rule action. Values include:

REPUBLISH: Forwards data to another topic.

OTS: Forwards data to a Table Store instance.

MNS: Forwards data to a theme of Message Service (MNS).

FC: Forwards data to a function of Function Compute.

RDS: Forwards data to an instance of ApsaraDB for RDS.

Configuration String The configurations of this rule action.
ErrorActionFlag String Indicates whether this rule action is used to forward messages of errors that the data was not successfully forwarded to the specified destinations.
  • true: This rule action is used to forward error messages.
  • false: This rule action is not used to forward error messages, but to forward device related data.

Examples

Request example

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

Response example

  • JSON format
    {
      "RuleActionInfo": {
        "Type": "REPUBLISH", 
        "RuleId": 152323, 
        "Id": 100001, 
        "Configuration": "{\"topic\":\"/sys/a1zSA28HUyy/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579*******\"}", 
        "ErrorActionFlag": false
      }, 
      "RequestId": "F2D0755D-F350-40FE-9A6D-491859DB5E5F", 
      "Success": true
    }
  • XMLformat
    <? xml version="1.0" encoding="UTF-8" ? >
    <GetRuleActionResponse>
        <RuleActionInfo>
            <Type>REPUBLISH</Type>
            <RuleId>152323</RuleId>
            <Id>100001</Id>
            <Configuration>
                <topic>/sys/a1zSA28HUyy/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>