すべてのプロダクト
Search

このプロダクト

    IoT Platform:QueryDeviceDetail

    ドキュメントセンター

    IoT Platform:QueryDeviceDetail

    最終更新日:Apr 17, 2025

    デバイスの詳細をクエリします。

    QPS 制限

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

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

    デバッグ

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

    リクエストパラメーター

    パラメーター タイプ 必須 例 説明
    Action String Yes QueryDeviceDetail

    実行する操作。値を QueryDeviceDetail に設定します。
    IotInstanceId String No iot-v64***

    インスタンスの ID。IoT Platform コンソールの [概要] ページでインスタンスの [ID] を表示できます。

    重要
    • インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。
    • インスタンスに対して [概要] ページまたは ID が生成されていない場合は、このパラメーターを設定する必要はありません。

    詳細については、「概要」をご参照ください。
    ProductKey String No a1BwAGV****

    デバイスが属するプロダクトの ProductKey。

    説明 このパラメーターに値を指定する場合は、DeviceName パラメーターにも値を指定する必要があります。
    DeviceName String No light

    デバイスの DeviceName。

    説明 このパラメーターに値を指定する場合は、ProductKey パラメーターにも値を指定する必要があります。
    IotId String No Q7uOhVRdZRRlDnTLv****00100

    デバイスの ID。

    説明 このパラメーターに値を指定する場合は、ProductKey パラメーターまたは DeviceName パラメーターに値を指定する必要はありません。 IotId パラメーターは、デバイスのグローバル一意識別子（GUID）を指定します。 IotId パラメーターの値は、ProductKey パラメーターと DeviceName パラメーターの値の組み合わせに対応します。 IotId パラメーターに値を指定し、ProductKey パラメーターと DeviceName パラメーターにも値を指定した場合、IotId の値が優先されます。

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

    レスポンスパラメーター

    パラメーター タイプ 例 説明
    Code String iot.system.SystemException

    呼び出しが失敗した場合に返されるエラーコード。 詳細については、「エラーコード」をご参照ください。
    Data Struct

    呼び出しが成功した場合に返されるデバイスの詳細。
    DeviceName String light

    デバイスの DeviceName。
    DeviceSecret String mz2Canp4GB7qRVf1OYPNtRqB2anu****

    デバイスの DeviceSecret。
    FirmwareVersion String V1.0.0.0

    デバイスのデフォルト OTA モジュールのバージョン番号。

    他の OTA モジュールのバージョン情報をクエリする場合は、ListOTAModuleVersionsByDevice 操作を呼び出します。バージョン情報はデバイスから送信されます。
    GmtActive String 2018-08-06 10:48:41

    デバイスがアクティブ化された日時。時刻は GMT 形式です。
    GmtCreate String 2018-08-06 10:47:50

    デバイスが作成された日時。時刻は GMT 形式です。
    GmtOnline String 2018-08-06 13:43:12

    デバイスがオンラインになった最新の日時。時刻は GMT 形式です。
    IotId String Q7uOhVRdZRRlDnTLv****00100

    デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。
    IpAddress String 10.0.0.1

    デバイスの IP アドレス。
    Nickname String detectors_in_beijing

    デバイスのエイリアス。
    NodeType Integer 0

    ノードのタイプ。有効な値：

    • 0: デバイス。サブデバイスはデバイスにアタッチできません。デバイスは、IoT Platform に直接接続するか、ゲートウェイのサブデバイスとして接続できます。
    • 1: ゲートウェイ。サブデバイスはゲートウェイにアタッチできます。ゲートウェイは、サブデバイスを管理し、サブデバイスとのトポロジ関係を維持し、トポロジ関係を IoT Platform に同期できます。
    Owner Boolean true

    操作がデバイスの所有者によって呼び出されたかどうかを示します。
    ProductKey String a1rYuVF****

    デバイスが属するプロダクトの ProductKey。
    ProductName String test

    デバイスが属するプロダクトの名前。
    Region String cn-shanghai

    デバイスが存在するリージョンの ID。リージョンは、IoT Platform が存在するリージョンと同じです。リージョンは、IoT Platform コンソールで確認できます。
    Status String ONLINE

    デバイスのステータス。有効な値：

    • ONLINE: デバイスはオンラインです。
    • OFFLINE: デバイスはオフラインです。
    • UNACTIVE: デバイスはアクティブ化されていません。
    • DISABLE: デバイスは無効になっています。
    UtcActive String 2018-08-06T02:48:41.000Z

    デバイスがアクティブ化された日時。時刻は UTC 形式です。
    UtcCreate String 2018-08-06T02:47:50.000Z

    デバイスが作成された日時。時刻は UTC 形式です。
    UtcOnline String 2018-08-06T05:43:12.000Z

    デバイスがオンラインになった最新の日時。時刻は UTC 形式です。
    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=QueryDeviceDetail
&ProductKey=a1rYuVF****
&DeviceName=device1
&<共通リクエストパラメーター>

    成功レスポンスの例

    XML 形式

    <QueryDeviceDetailResponse>
  <Data>
        <Owner>true</Owner>
        <GmtActive>2020-01-16 13:33:37</GmtActive>
        <DeviceName>Humidity</DeviceName>
        <ProductKey>a1ttsqu****</ProductKey>
        <DeviceSecret>sLefbFmN9SYfnWLJTePG893XNuRV****</DeviceSecret>
        <IpAddress>42.120.75.144</IpAddress>
        <GmtCreate>2020-01-08 14:47:08</GmtCreate>
        <UtcCreate>2020-01-08T06:47:08.000Z</UtcCreate>
        <IotId>dwnS41bhNxjslDAIF****00100</IotId>
        <Status>OFFLINE</Status>
        <UtcOnline>2020-01-17T08:19:11.091Z</UtcOnline>
        <Region>cn-shanghai</Region>
        <UtcActive>2020-01-16T05:33:37.830Z</UtcActive>
        <Nickname>Temperature and humidity</Nickname>
        <NodeType>0</NodeType>
        <GmtOnline>2020-01-17 16:19:11</GmtOnline>
        <ProductName>Light, temperature, and humidity sensor
  </Data>
  <RequestId>D2D2DE90-DD0F-44EA-9F56-63F07A59F65B</RequestId>
  <Success>true</Success>
</QueryDeviceDetailResponse>

    JSON 形式

    {
	"Data": {
		"Owner": true,
		"GmtActive": "2020-01-16 13:33:37",
		"DeviceName": "Humidity",
		"ProductKey": "a1ttsqu****",
		"DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
		"IpAddress": "42.120.75.144",
		"GmtCreate": "2020-01-08 14:47:08",
		"UtcCreate": "2020-01-08T06:47:08.000Z",
		"IotId": "dwnS41bhNxjslDAIF****00100",
		"Status": "OFFLINE",
		"UtcOnline": "2020-01-17T08:19:11.091Z",
		"Region": "cn-shanghai",
		"UtcActive": "2020-01-16T05:33:37.830Z",
		"NickName": "Temperature and humidity",
		"NodeType": 0,
		"GmtOnline": "2020-01-17 16:19:11",
		"ProductName": "Light, temperature, and humidity sensor"
	},
	"RequestId": "D2D2DE90-DD0F-44EA-9F56-63F07A59F65B",
	"Success": true
}

    エラーコード

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