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

ルールをページごとにクエリします。

QPS 制限

この API 操作は、アカウントごとに 1 秒あたり最大 20 回呼び出すことができます。

説明

Alibaba Cloud アカウントの Resource Access Management (RAM) ユーザーは、アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	データ型	必須	例	説明
Action	String	はい	ListRule	実行する操作。値を ListRule に設定します。
CurrentPage	Integer	はい	1	ページ番号。最大値：1000。デフォルト値：1。
PageSize	Integer	はい	2	1 ページあたりのエントリ数。有効な値：1 ～ 100。デフォルト値：10。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンス ID。インスタンス ID は、IoT Platform コンソールの概要タブで確認できます。重要インスタンスに ID がある場合は、このパラメーターを指定する必要があります。このパラメーターを指定しないと、リクエストは失敗します。 IoT Platform コンソールに概要タブまたはインスタンス ID が表示されない場合は、このパラメーターを指定する必要はありません。インスタンスの詳細については、「概要」をご参照ください。
ResourceGroupId	String	いいえ	rg-acfmxazb4ph****	リソースグループ ID。重要 IoT Platform は、インスタンスごとのみリソースグループ管理をサポートしています。 ResourceGroupId パラメーターは無効です。このパラメーターを指定する必要はありません。

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

レスポンスパラメーター

パラメーター	データ型	例	説明
Code	String	iot.system.SystemException	リクエストが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	RuleInfo の配列		リクエストが成功した場合に返されるルール。詳細については、このトピックの RuleInfo パラメーターの説明をご参照ください。説明返されるルールは、ルールが作成された時刻に基づいて降順にソートされます。
RuleInfo
CreateUserId	Long	1231579085000000	ルールを作成したユーザーの ID。
Created	String	Wed Feb 27 20:45:43 CST 2019	ルールが作成された時刻。時刻は UTC-6 で表示されます。
DataType	String	JSON	ルールのデータ型。有効な値： JSON および BINARY。
Id	Long	151454	ルール ID。
Modified	String	Wed Feb 27 20:45:43 CST 2019	ルールが最後に変更された時刻。時刻は UTC-6 で表示されます。
Name	String	test123	ルールの名前。
ProductKey	String	a1KiV******	ルールが適用されるプロダクトの ProductKey。
RuleDesc	String	rule1Desc	ルールの説明。
Select	String	deviceName() as deviceName	ルールの SQL 文の SELECT 句の内容。
ShortTopic	String	+/thing/event/property/post	ルールが適用されるトピックの名前 (ProductKey を除く)。値の形式は `${deviceName}/topicShortName` です。 ${deviceName} はデバイスの名前を示し、topicShortName はトピックのカスタム名を示します。説明トピック名には、`+` または `#` ワイルドカード文字が含まれる場合があります。詳細については、「トピック」をご参照ください。
Status	String	STOP	ルールの状態。有効な値： RUNNING：ルールは実行中です。 STOP：ルールは停止しています。
Topic	String	/a1T27vz****/+/thing/event/property/post	ルールが適用されるトピックの名前 (ProductKey を含む)。値の形式は `${productKey}/${deviceName}/topicShortName` です。説明トピック名には、`+` または `#` ワイルドカード文字が含まれる場合があります。詳細については、「トピック」をご参照ください。
UtcCreated	String	2019-02-27T12:40:43.000Z	ルールが作成された時刻。時刻は UTC で表示されます。
UtcModified	String	2019-02-27T12:45:43.000Z	ルールが最後に変更された時刻。時刻は UTC で表示されます。
Where	String	Temperature>35	ルールの SQL 文の WHERE 句の条件。
ErrorMessage	String	A system exception occurred.	リクエストが失敗した場合に返されるエラーメッセージ。
Page	Integer	1	ページ番号。
PageSize	Integer	2	1 ページあたりのエントリ数。
RequestId	String	1564B626-DE97-452D-9E9B-305888AC6105	リクエスト ID。
Success	Boolean	true	リクエストが成功したかどうかを示します。有効な値： true false
Total	Integer	25	返されるページの総数。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=ListRule
&PageSize=2
&CurrentPage=1
&<Common request parameters>

成功レスポンスの例

XML 形式

<ListRuleResponse>
  <Data>
        <RuleInfo>
              <DataType>JSON</DataType>
              <ProductKey>a1T27vz****</ProductKey>
              <CreateUserId>198426864326****</CreateUserId>
              <UtcModified>2020-02-26T06:38:27.000Z</UtcModified>
              <UtcCreated>2020-02-26T02:50:44.000Z</UtcCreated>
              <Where>Temperature&gt;35</Where>
              <Name>testrule2</Name>
              <Status>STOP</Status>
              <Select>deviceName() as DeviceName</Select>
              <Created>Wed Feb 26 10:50:44 CST 2020</Created>
              <Modified>Wed Feb 26 14:38:27 CST 2020</Modified>
              <Topic>/a1T27vz****/+/thing/event/property/post</Topic>
              <Id>497350</Id>
        </RuleInfo>
  </Data>
  <Page>1</Page>
  <PageSize>1</PageSize>
  <RequestId>1A6131EC-7504-4673-B997-DEFC6B363A37</RequestId>
  <Success>true</Success>
  <Total>5</Total>
</ListRuleResponse>

JSON 形式

{
	"Data": {
		"RuleInfo": [
			{
				"DataType": "JSON",
				"ProductKey": "a1T27vz****",
				"CreateUserId": "198426864326****",
				"UtcModified": "2020-02-26T06:38:27.000Z",
				"UtcCreated": "2020-02-26T02:50:44.000Z",
				"Where": "Temperature>35",
				"Name": "testrule2",
				"Status": "STOP",
				"Select": "deviceName() as DeviceName",
				"Created": "Wed Feb 26 10:50:44 CST 2020",
				"Modified": "Wed Feb 26 14:38:27 CST 2020",
				"Topic": "/a1T27vz****/+/thing/event/property/post",
				"Id": 497350
			}
		]
	},
	"Page": 1,
	"PageSize": 1,
	"RequestId": "1A6131EC-7504-4673-B997-DEFC6B363A37",
	"Success": true,
	"Total": 5
}

エラーコード

エラーコードの一覧については、「サービスエラーコード」をご参照ください。