调用该接口停止指定的规则。

限制说明

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为50。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String StopRule

系统规定参数。取值:StopRule。

RuleId Long 100000

要停止的规则ID。可在物联网平台控制台对应实例下规则引擎>云产品流转页查看规则ID,或调用ListRule从返回结果中查看。

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

实例ID。

您可在物联网平台控制台的实例概览页面,查看当前实例的ID。若有ID值,必须传入该ID值,否则调用会失败。

说明 如果公共实例没有ID值,请参见如何获取实例ID

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时,返回的错误码。更多信息,请参见错误码

ErrorMessage String 系统异常

调用失败时,返回的出错信息。

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

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功。

  • true表示调用成功。
  • false表示调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=StopRule
&RuleId=100000
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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