GetRule - IoT Platform - Alibaba Cloud ドキュメントセンター

指定されたルールの詳細情報を照会します。

制限

各 Alibaba Cloud アカウントは、最大 50 クエリ/秒（QPS）を実行できます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	GetRule	実行する操作。値を GetRule に設定します。
RuleId	Long	はい	100000	照会するルールの ID。IoT Platform コンソールにログインし、[ルール] > [データ転送] を選択して、ルール ID を表示できます。ListRule オペレーションを呼び出し、レスポンスでルール ID を表示することもできます。
IotInstanceId	String	いいえ	iot-cn-0pp1n8t****	インスタンスの ID。IoT Platform コンソールの [概要] ページでインスタンス [ID] を表示できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに [概要] ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	58D4CEC0-3E95-4DBE-AFC1-809D1400E52F	リクエストの ID。
RuleInfo	Struct		呼び出しが成功した場合に返されるルール情報。詳細については、「RuleInfo」を参照してください。
CreateUserId	Long	100000000000000	ルールを作成したユーザーの ID。
Created	String	Thu Feb 28 14:14:33 CST 2019	ルールが作成された時刻。時刻は UTC-6 で表示されます。
DataType	String	JSON	ルールのデータ型。有効な値：JSON および BINARY。
Id	Long	100000	ルールの ID。
Modified	String	Thu Feb 28 14:20:58 CST 2019	ルールが最後に変更された時刻。時刻は UTC-6 で表示されます。
Name	String	iotrules	ルールの名前。
ProductKey	String	a1KiV******	ルールが適用されるプロダクトの ProductKey。
RuleDesc	String	rule1Desc	このルールの説明。
Select	String	deviceName() as deviceName	ルールの SQL 文における Select の値。
ShortTopic	String	+/user/pm25data	ルールが適用されるトピック。トピックには ProductKey レベルは含まれません。フォーマット：`${deviceName}/topicShortName`。${deviceName} はデバイスの名前を示し、topicShortName はトピックのカスタム名を示します。説明トピックで `+` または `#` ワイルドカードを使用する方法については、「トピックのワイルドカード」をご参照ください。
Status	String	STOP	ルールのステータス。有効な値： RUNNING：実行中 STOP：停止
Topic	String	/a1QsMlL44pp/+/user/pm25data	ルールが適用される完全なトピック。フォーマット：`${productKey}/${deviceName}/topicShortName`。説明トピックで `+` または `#` ワイルドカードを使用する方法については、「トピックのワイルドカード」をご参照ください。
TopicType	Integer	1	トピックのタイプ。このパラメーターは、ルールの SQL 文を設定した場合に返されます。有効な値： 0：基本的な通信トピックまたは TSL 通信トピック。 1：カスタムトピック。 2：デバイスステータストピック。ルールに SQL 文が設定されていない場合は、値 -1 が返されます。
UtcCreated	String	2019-02-28T06:14:33.000Z	ルールが作成された時刻。時刻は UTC で表示されます。
UtcModified	String	2019-02-28T06:20:58.000Z	ルールが最後に変更された時刻。時刻は UTC で表示されます。
Where	String	Temperature>35	ルールの SQL 文における Where クエリ条件。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true：呼び出しは成功しました。 false：呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=GetRule
&RuleId=100000
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<GetRuleResponse>
  <RequestId>85648524-E5EE-418E-BD16-FAFBB4FF3645</RequestId>
  <Success>true</Success>
  <RuleInfo>
        <DataType>JSON</DataType>
        <ShortTopic>+/user/pm25data</ShortTopic>
        <ProductKey>a1QsMl****</ProductKey>
        <UtcModified>2019-12-23T03:34:45.000Z</UtcModified>
        <CreateUserId>198426864326****</CreateUserId>
        <UtcCreated>2019-12-23T02:32:06.000Z</UtcCreated>
        <Name>Ruff_rule1</Name>
        <Status>RUNNING</Status>
        <Select>deviceName() as deviceName , timestamp('yyyy-MM-dd HH:mm:ss') as time, pm25, pm10</Select>
        <Created>Mon Dec 23 10:32:06 CST 2019</Created>
        <Modified>Mon Dec 23 11:34:45 CST 2019</Modified>
        <TopicType>1</TopicType>
        <Topic>/a1QsMlL****/+/user/pm25data</Topic>
        <Id>425367</Id>
  </RuleInfo>
</GetRuleResponse>

JSON 形式

{
    "RequestId": "85648524-E5EE-418E-BD16-FAFBB4FF3645",
    "Success": true,
    "RuleInfo": {
        "DataType": "JSON",
        "ShortTopic": "+/user/pm25data",
        "ProductKey": "a1QsMl****",
        "UtcModified": "2019-12-23T03:34:45.000Z",
        "CreateUserId": "198426864326****",
        "UtcCreated": "2019-12-23T02:32:06.000Z",
        "Name": "Ruff_rule1",
        "Status": "RUNNING",
        "Select": "deviceName() as deviceName , timestamp('yyyy-MM-dd HH:mm:ss') as time, pm25, pm10",
        "Created": "Mon Dec 23 10:32:06 CST 2019",
        "Modified": "Mon Dec 23 11:34:45 CST 2019",
        "TopicType": 1,
        "Topic": "/a1QsMlL****/+/user/pm25data",
        "Id": 425367
    }
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。