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

デバイスのステータスを照会します。

制限

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

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

デバッグ

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

リクエストパラメーター

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

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるデバイスステータス。
Status	String	ONLINE	デバイスのステータス。有効な値： ONLINE: デバイスはオンラインです。 OFFLINE: デバイスはオフラインです。 UNACTIVE: デバイスはアクティブ化されていません。 DISABLE: デバイスは無効になっています。
Timestamp	Long	1557062301656	デバイスステータスが変更された時刻。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

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

成功レスポンスの例

XML 形式

<GetDeviceStatusResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>ONLINE</Status>
        <Timestamp>1557062301656</Timestamp>
  </Data>
  <Success>true</Success>
</GetDeviceStatusResponse>

JSON 形式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "ONLINE",
        "Timestamp": 1557062301656
    },
    "Success": true
}

エラーコード

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