QueryDeviceProp - 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	はい	QueryDeviceProp	実行する操作。値を QueryDeviceProp に設定します。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
ProductKey	String	いいえ	a1BwAGV****	デバイスが属するプロダクトの ProductKey。説明このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。
DeviceName	String	いいえ	light	デバイスの DeviceName。説明このパラメーターを指定する場合は、ProductKey パラメーターも指定する必要があります。
IotId	String	いいえ	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。デバイス ID は IoT Platform によって発行されます。説明このパラメーターを指定する場合は、ProductKey または DeviceName を指定する必要はありません。 IotId パラメーターは、ProductKey と DeviceName の組み合わせに対応する、デバイスのグローバル一意識別子（GUID）を指定します。 IotId と ProductKey と DeviceName の組み合わせの両方を指定した場合、IotId が優先されます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
Props	String	{"coordinate":"104.07086:30.549169"}	呼び出しが成功した場合に返される JSON 文字列。JSON 文字列には、デバイスタグの詳細が含まれています。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceProp
&ProductKey=a1BwAGV****
&DeviceName=device1
&<Common request parameters>

成功レスポンスの例

XML 形式

<QueryDevicePropResponse>
  <RequestId>D8CEF5E7-1484-4164-A242-C06BA3A54E0F</RequestId>
  <Props>{"coordinate":"104.07086:30.549169"}</Props>
  <Success>true</Success>
</QueryDevicePropResponse>

JSON 形式

{
    "RequestId": "D8CEF5E7-1484-4164-A242-C06BA3A54E0F",
    "Props": "{\"coordinate\":\"104.07086:30.549169\"}",
    "Success": true
}

エラーコード

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