Enables a specified rule.

Limits

  • Before you start a rule, make sure that an SQL statement is set for the rule. If you do not set an SQL statement when you create the rule, call the UpdateRule operation to add an SQL statement and update the rule.
  • 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

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 StartRule

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

RuleId Long Yes 100000

The ID of the rule that you want to enable. You can log on to the IoT Platform console and choose Rules > Data Forwarding to view the rule ID. You can also call the ListRule operation and view the rule ID in the response.

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 operation-specific request parameters, you must specify common request parameters when you call this operation. For 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 fails. For more information, see Error codes.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String 9A2F243E-17FE-4846-BAB5-D02A25155AC4

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=StartRule
&RuleId=100000
&<Common request parameters>

Sample success responses

XML format

<StartRuleResponse>
      <RequestId>9A2F243E-17FE-4846-BAB5-D02A25155AC4</RequestId>
      <Success>true</Success>
</StartRuleResponse>

JSON format

{
    "RequestId":"9A2F243E-17FE-4846-BAB5-D02A25155AC4",
    "Success":true
}

Error codes

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