调用该接口分页查询所有规则列表。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:ListRule
PageSize Integer 返回结果中每页显示的记录数量。最大取值100,默认值是10。
CurrentPage Integer 显示返回结果中的第几页。最大取值 1000,默认值 1。
IotInstanceId String 共享实例不传此参数;仅独享实例需传入实例ID。
公共请求参数 - 请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 表示是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码
Data RuleInfo 调用成功时,返回的规则信息列表。详情参见下表RuleInfo。
说明 返回规则信息按照规则创建时间倒序排列。
PageSize Integer 每页显示的记录数。
Page Integer 当前页码。
Total Integer 总页数。
表 1. RuleInfo
名称 类型 描述
CreateUserId Long 创建该规则的用户ID。
Created String 该规则创建时的CST(Central Standard Time)时间。
DataType String 该规则的数据类型,取值:JSONBINARY
Id Long 规则ID。
Modified String 该规则最近一次被修改时的CST (Central Standard Time)时间。
Name String 规则名称。
ProductKey String 应用该规则的产品Key。
RuleDesc String 规则的描述信息。
Select String 该规则SQL语句中的Select内容。
ShortTopic String 应用该规则的具体Topic(不包含ProductKey类目),格式为:${deviceName}/topicShortName。其中,${deviceName}指具体设备的名称,topicShortName是该设备的自定义类目。
Status String

该规则的运行状态。取值:

RUNNING:运行中

STOP:停止

Topic String 应用该规则的具体Topic,格式为:${productKey}/${deviceName}/topicShortName
UtcModified String 该规则最近一次被修改时的UTC时间。
UtcCreated String 该规则创建时的UTC时间。
Where String 该规则SQL语句中的Where查询条件。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=ListRule
&PageSize=2
&CurrentPage=1
&公共请求参数

返回示例

  • JSON格式
    {
      "Data": {
        "RuleInfo": [
          {
            "DataType": "JSON", 
            "ShortTopic": "+/#", 
            "ProductKey": "a1KiV******", 
            "CreateUserId": "1231579085******", 
            "UtcModified": "2019-02-28T06:20:58.000Z", 
            "UtcCreated": "2019-02-28T06:14:33.000Z", 
            "Name": "iotrules", 
            "Status": "STOP", 
            "Select": "deviceName() as deviceName", 
            "Created": "Thu Feb 28 14:14:33 CST 2019", 
            "Modified": "Thu Feb 28 14:20:58 CST 2019", 
            "Topic": "/a1KiV******/+/#", 
            "Id": 152323
          }, 
          {
            "Name": "test123", 
            "Status": "STOP", 
            "Created": "Wed Feb 27 20:45:43 CST 2019", 
            "DataType": "JSON", 
            "Modified": "Wed Feb 27 20:45:43 CST 2019", 
            "UtcModified": "2019-02-27T12:45:43.000Z", 
            "CreateUserId": "1231579085******", 
            "Id": 151454, 
            "UtcCreated": "2019-02-27T12:45:43.000Z"
          }
        ]
      }, 
      "PageSize": 2, 
      "Page": 1, 
      "RequestId": "1564B626-DE97-452D-9E9B-305888AC6105", 
      "Success": true, 
      "Total": 25
    }
  • XML格式
    <?xml version="1.0" encoding="UTF-8" ?>
    <ListRuleResponse>
        <Data>
            <RuleInfo>
                <DataType>JSON</DataType>
                <ShortTopic>+/#</ShortTopic>
                <ProductKey>a1KiV******</ProductKey>
                <CreateUserId>1231579085******</CreateUserId>
                <UtcModified>2019-02-28T06:20:58.000Z</UtcModified>
                <UtcCreated>2019-02-28T06:14:33.000Z</UtcCreated>
                <Name>iotrules</Name>
                <Status>STOP</Status>
                <Select>deviceName() as deviceName</Select>
                <Created>Thu Feb 28 14:14:33 CST 2019</Created>
                <Modified>Thu Feb 28 14:20:58 CST 2019</Modified>
                <Topic>/a1KiV******/+/#</Topic>
                <Id>152323</Id>
            </RuleInfo>
            <RuleInfo>
                <Name>test123</Name>
                <Status>STOP</Status>
                <Created>Wed Feb 27 20:45:43 CST 2019</Created>
                <DataType>JSON</DataType>
                <Modified>Wed Feb 27 20:45:43 CST 2019</Modified>
                <UtcModified>2019-02-27T12:45:43.000Z</UtcModified>
                <CreateUserId>1231579085******</CreateUserId>
                <Id>151454</Id>
                <UtcCreated>2019-02-27T12:45:43.000Z</UtcCreated>
            </RuleInfo>
        </Data>
        <PageSize>2</PageSize>
        <Page>1</Page>
        <RequestId>87B1B7C3-FD90-4B80-93BC-A52F7996A903</RequestId>
        <Success>true</Success>
        <Total>25</Total>
    </ListRuleResponse>