Queries all data forwarding actions of a specified rule.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListRuleActions

The operation that you want to perform. Set the value to ListRuleActions.

RuleId Long Yes 10000

The ID of the rule that you want to query. You can use either of the following methods to view the rule ID: 1. Log on to the IoT Platform console and choose Rules>Data Forwarding. 2. Call the ListRule operation.

IotInstanceId String No iot_instc_pu****_c*-v64********

The ID of the instance. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.

In addition to the preceding exclusive request parameters, you must specify common request parameters when calling this API operation. For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call failed. For more information about error codes, see Error codes.

ErrorMessage String A system exception occurred.

The error message returned if the call failed.

RequestId String 22254BDB-3DC1-4643-8D1B-EE0437EF09A9

The globally unique ID that is generated by Alibaba Cloud for the request.

RuleActionList Array

The rule action information returned if the call was successful. For more information, see the following parameters included in the RuleActionInfo parameter.

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******\"}

The configurations of the rule action.

ErrorActionFlag Boolean false

Indicates whether the rule action forwarded error operation data that failed to be forwarded to the destination cloud service. A data forwarding failure indicates that forwarding retries also failed.

  • true: forwards error operation data.
  • false: forwards normal data instead of error operation data.
Id Long 139099

The ID of the rule action.

RuleId Long 10000

The ID of the rule based on which the rule action is performed.

Type String OTS

The type of the rule action. Valid values:

  • REPUBLISH: forwards data to another topic.
  • OTS: stores data to Table Store.
  • MNS: sends data to Message Service (MNS).
  • FC: sends data to Function Compute.
  • RDS: stores data to cloud databases.
  • AMQP: forwards data to Message Queue for AMQP consumer groups.
Success Boolean true

Indicates whether the call was successful. true indicates that the call was successful. false indicates that the call failed.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

  "RuleActionList": {
    "RuleActionInfo": [
        "Type": "OTS", 
        "RuleId": 10000, 
        "Id": 139099, 
        "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, 
        "Configuration": "{\"topic\":\"/sys/a1zSA28H***/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579085******\"}", 
        "ErrorActionFlag": false
  "RequestId": "22254BDB-3DC1-4643-8D1B-EE0437EF09A9", 
  "Success": true

Error codes

For a list of error codes, visit the API Error Center.