Modifies a specified rule action.

Limits

Each Alibaba Cloud account can run a maximum of 50 queries per second (QPS).

Note RAM users of an Alibaba Cloud account share the quota of the account.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. 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.

After you call the CreateRuleAction operation to create a rule action, the rule action ID is returned. You can call the ListRuleActions operation to view the rule action ID.

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 topic data that is processed by the rules engine to MNS.
  • FC: forwards topic data that is processed by the rules engine to Function Compute for event computing.
  • REPUBLISH: forwards topic data that is processed by the rules engine to another IoT Platform topic.
  • AMQP: forwards data to an AMQP consumer group.
  • OTS: forwards topic data that is processed by the rules engine to Tablestore for NoSQL data storage.
Note
  • If you set the DataType parameter to BINARY, rules are created in the binary format. These rules cannot be used to forward data to Tablestore.
  • Destination Alibaba Cloud services that are supported by the rules engine vary based on regions. For more information about the regions and destination cloud services that are supported by the rules engine, see Regions and zones.
IotInstanceId String No iot-cn-0pp1n8t****

The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
  • If your instance has no Overview page or ID, you do not need to set this parameter.

For more information, see Overview.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

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

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String 21D327AF-A7DE-4E59-B5D1-ACAC8C024555

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: 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.