Modifies a specified rule action.

Debugging

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 UpdateRuleAction

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

ActionId Long Yes 1000003

The ID of the rule action to be modified. You can call the CreateRuleAction operation to view the ActionId response parameter. You can also call the ListRuleActions operation to view the Id response parameter.

Configuration String Yes {"topic":"/a1iYSOl****/device5/user/get","topicType":1}

The configurations of the rule action. The configurations for different rule action types are different. For more information about the configurations for different rule action types, see CreateRuleAction.

Type String Yes REPUBLISH

The type of the rule action. Valid values:

  • MNS: forwards data in the topics that have been processed by the rule engine to Message Service (MNS) for message transmission.
  • FC: forwards data in the topics that have been processed by the rule engine to Function Compute for event computing.
  • REPUBLISH: forwards data in the topics that have been processed by the rule engine to another IoT Platform topic.
  • AMQP: forwards data to Message Queue for AMQP consumer groups.
  • OTS: forwards data in the topics that have been processed by the rule engine to Table Store for NoSQL data storage.
Note
  • Rules of the binary data format (the DataType parameter is set to BINARY) do not support forwarding data to Table Store.
  • Destination Alibaba Cloud services that are supported by the rule engine vary based on regions. For more information about the regions and destination cloud services that are supported by the rule engine, see Regions and zones.
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 21D327AF-A7DE-4E59-B5D1-ACAC8C024555

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

Success Boolean true

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

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateRuleAction
&ActionId=10003
&Type=REPUBLISH
&Configuration={"topic":"/a1iYSOl****/device5/user/get","topicType":1}
&<Common request parameters>

Sample success responses

XML format

<UpdateRuleActionResponse>
      <RequestId>9A2F243E-17FE-4874-QBB5-D02A25155AC8</RequestId>
      <Success>true</Success>
</UpdateRuleActionResponse>

JSON format

{
    "RequestId": "21D327AF-A7DE-4E59-B5D1-ACAC8C024555",
    "Success": true
}

Error codes

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