QueryDeviceStatistics でデバイス統計を取得 - IoT

オンラインデバイス数、アクティブ化されたデバイス数、作成されたデバイスの総数など、デバイスの統計情報をクエリします。

制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	QueryDeviceStatistics	実行する操作。値を QueryDeviceStatistics に設定します。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
ProductKey	String	いいえ	a1BwAGV****	デバイスが属するプロダクトの ProductKey。このパラメーターを指定すると、プロダクト配下のデバイスの統計情報が返されます。 GroupId も指定した場合、プロダクト配下で作成され、グループに追加されたデバイスの統計情報が返されます。このパラメーターと GroupId を指定しない場合、現在のアカウント内のすべてのデバイスの統計情報が返されます。
GroupId	String	いいえ	W16X8Tvdosec****	デバイスが属するグループの ID。このパラメーターを指定すると、グループに追加されたデバイスの統計情報が返されます。 ProductKey も指定した場合、プロダクト配下で作成され、グループに追加されたデバイスの統計情報が返されます。このパラメーターと ProductKey を指定しない場合、現在のアカウント内のすべてのデバイスの統計情報が返されます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるデバイス統計情報。
activeCount	Long	10	アクティブ化されたデバイスの数。
deviceCount	Long	100	デバイスの総数。
onlineCount	Long	10	オンラインデバイスの数。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

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

成功レスポンスの例

XML 形式

<QueryDeviceStatisticsResponse>
  <Data>
        <deviceCount>2</deviceCount>
        <activeCount>2</activeCount>
        <onlineCount>0</onlineCount>
  </Data>
  <RequestId>8AC026D2-6F16-4719-A396-969D63DCA138</RequestId>
  <Success>true</Success>
</QueryDeviceStatisticsResponse>

JSON 形式

{
    "Data": {
        "deviceCount": 2,
        "activeCount": 2,
        "onlineCount": 0
    },
    "RequestId": "8AC026D2-6F16-4719-A396-969D63DCA138",
    "Success": true
}

エラーコード

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