调用该接口查询指定规则的详细信息。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:GetRule
RuleId Long 要查询的规则ID。
IotInstanceId String 共享实例不传此参数;仅独享实例需传入实例ID。
公共请求参数 - 请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 表示是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码
RuleInfo RuleInfo 调用成功时,返回的规则详细信息。详情参见下表RuleInfo。
表 1. RuleInfo
名称 类型 描述
CreateUserId Long 创建该规则的用户ID。
Created String 该规则创建时的CST时间。
DataType String 该规则的数据类型,取值:JSONBINARY
Id Long 规则ID。
Modified String 该规则最近一次被修改时的CST时间。
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
Where String 该规则SQL语句中的Where查询条件。
TopicType Integer

若您设置了规则SQL语句,则返回:

  • 0:表示系统Topic。

  • 1:表示自定义Topic。

  • 2:表示设备状态Topic。

若未设置过规则SQL语句,则返回-1

UtcCreated String 规则创建时的UTC时间。
UtcModified String 规则最近一次更新时的UTC时间。

示例

请求示例

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

返回示例

  • JSON格式
    {
        "RequestId": "58D4CEC0-3E95-4DBE-AFC1-809D1400E52F",
        "Success": true,
        "RuleInfo": {
            "DataType": "JSON",
            "ShortTopic": "+/#",
            "ProductKey": "a1KiV******",
            "UtcModified": "2019-02-28T06:20:58.000Z",
            "CreateUserId": "12******85529123",
            "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",
            "TopicType": 1,
            "Topic": "/a1KiV******/+/#",
            "Id": 100000
        }
    }
  • XML格式
    <?xml version="1.0" encoding="UTF-8" ?>
    <GetRuleResponse>
        <RequestId>58D4CEC0-3E95-4DBE-AFC1-809D1400E52F</RequestId>
        <Success>true</Success>
        <RuleInfo>
            <DataType>JSON</DataType>
            <ShortTopic>+/#</ShortTopic>
            <ProductKey>a1KiV******</ProductKey>
            <UtcModified>2019-02-28T06:20:58.000Z</UtcModified>
            <CreateUserId>1231579085******</CreateUserId>
            <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>
            <TopicType>1</TopicType>
            <Topic>/a1KiV******/+/#</Topic>
            <Id>100000</Id>
        </RuleInfo>
    </GetRuleResponse>