特定のデバイスの詳細情報を照会します。
リクエスト URL
GET {base_url}/device/openapi/v1/devices/{deviceId}
リクエストパラメータ
パラメータ | 必須 | タイプ | 説明 |
---|---|---|---|
Authorization | Yes | String | API 呼び出しを行うための有効なアクセストークン。
形式は Bearer {access_token} である必要があります。 |
パラメータ | 必須 | タイプ | 説明 |
---|---|---|---|
deviceId | Yes | Long | このデバイスの一意の ID。デバイスを追加するときに返されます。
注: deviceID を保存していない場合は、特定のデバイスを検索を使用してデバイスの ID を照会できます。 |
応答パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
data | Object<Device_Info> | 照会したデバイスの詳細情報。 |
status | String | API リクエストの結果。
|
requestId | String | リクエストの一意の ID。リクエストをすばやく見つけるために使用できます。 |
- Device_Info
-
パラメータ タイプ 説明 sn String - このデバイスの SN (シリアル番号)。
imei String - このデバイスの IMEI (国際移動体装置識別番号)
rpsStatus String - デバイスの RPS サービスのステータス。
ACTIVATE
: このデバイスのRPSが有効です。UNACTIVATED
: このデバイスのRPSが無効または未対応です。
name String - デバイスの名前
model String - デバイスのモデル
hardwareVersion String - デバイスのハードウェアバージョン
firmwareVersion String - デバイスのファームウェアバージョン
electricity Integer - デバイスのバッテリーレベル
lastUpdateTime Long - デバイスの最新のレポートのタイムスタンプ
application Object - デバイスに関連付けられたアプリケーションの情報
applicationId Long - このアプリケーションのユニークID
applicationName String - このアプリケーションの名前
project String - デバイスのプロジェクトタグ
description String - デバイスの説明
deviceId Long - このデバイスのユニークID
devEUI String - このデバイスのEUI(拡張一意識別子)
connectStatus String - デバイスの接続状態
ONLINE
: デバイスは Milesight 開発プラットフォームにアクティブに接続されています。OFFLINE
: デバイスは現在 Milesight 開発プラットフォームに接続されていません。DISCONNECT
: デバイスは Milesight 開発プラットフォームから切断されています。
licenseStatus String - デバイスのライセンスステータス
VALID
: デバイスは使用できますINVALID
: プロプランの有効期限が切れたため、デバイスは使用できなくなりました。
deviceType String このデバイスのタイプ。 GATEWAY
: サブデバイスと Milesight 開発プラットフォーム間の通信を設定するゲートウェイデバイス。SUB_DEVICE
: Milesight 開発プラットフォームに接続するためにゲートウェイを必要とする、インターネットにアクセスできないデバイス。COMMON
: Milesight 開発プラットフォームに直接接続できる、インターネットにアクセスできるデバイス。
tag Array<String> このデバイスのタグ。
例
- リクエスト例
- ID「1739930666380779522」のデバイスの詳細情報を照会します。
-
GET /device/openapi/v1/devices/1739930666380779522 HTTP/1.1 Host: demo.milesight.com Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InllYXN0b25lLWRlZmF1bHQta2V5LWlkIn0.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsib3BlbmFwaSJdLCJjbGllbnRfZXh0Ijp7ImFwcF9pZCI6IjE3MzY5NTQ4MDE3MTMzMjgxMzAifSwiZXhwIjoxNzAzMjEzMDk4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJiYjJjN2U4Yy03NGQwLTQ4NjEtODE3MS1iYTc0NWRlMGY0NmQiLCJjbGllbnRfaWQiOiI4OTNkNzdjNy1mMGNiLTRmMzQtOWNhMS03YzJhNGNmMTEzNDgiLCJ0cyI6MTcwMzIwOTQ5ODMzNH0 Content-Type: application/json
- レスポンス例
-
HTTP/1.1 200 OK { "data": { "sn": "6791D1970467xxxx", "rpsStatus": "UNACTIVATED", "name": "Demo Device", "model": "WS203", "hardwareVersion": "v1.0", "firmwareVersion": "v1.1", "electricity": 97, "lastUpdateTime": 1704172785337, "application": { "applicationId": "1734475086466600962", "applicationName": "Demo" }, "project": "Demo", "description": "Demo", "licenseStatus": "VALID", "deviceType": "SUB-DEVICE", "tag": [], "deviceId": "1739930666380779522", "devEUI": "24E124791D1xxxx", "connectStatus": "ONLINE" }, "status": "Success", "requestId": "c15d037ea4c74565ecced1725c8d46d6" }
関連記事
ソリューション / IoT サポート
- ▢3. Milesight開発プラットフォームAPIの概要システムをサードパーティのアプリケーションと統合するためのアプリケーションプログラミングインターフェース (API) を提供しています
- 3.1.1.1 APIリクエスト構造Milesight Development Platform APIのリクエスト構造について説明します
- 3.1.1.2 API レスポンス結果APIリクエストを受信すると、Milesight Development Platformはリクエストの結果を示すHTTPステータスコードと、API呼び出しで要求された情報を含むJSONレスポンスボディを返します。
- 3.1.2 API インターフェース一覧このトピックでは、Milesight Development Platform API のインターフェースの要約リストを提供します。
- 3.1.3.1 API 認証ルールMilesight Development Platform APIは、OAuth 2.0を使用して認証を行い、アプリケーションがMilesight Development Platform上のリソースにアクセスするためのセキュアなトークンを発行します。
- 3.1.3.2 API アクセス トークンの取得アクセス トークンは、認証された API 呼び出しを検証するために使用されます。アプリケーションはまずアクセス トークンをリクエストし、その後、Milesight Development Platform API にアクセスするすべてのリクエストにそのトークンを含める必要があります。
- 3.1.3.3 API アクセス トークンの更新Milesight Development Platformとアプリケーション間の安全でスムーズな通信を確保するため、アクセス トークンが有効期限切れになる前に更新する必要があります。
- 3.1.4.1 デバイスを追加するMilesight Development Platform にデバイスを追加し、現在のアプリケーションに関連付けます。
- 3.1.4.10 特定のデバイスの設定を取得する特定のデバイスの詳細な設定を照会します。
- 3.1.4.2 特定のデバイスを検索する現在のアプリケーションに関連付けられているすべてのデバイスから、特定のデバイスを検索します。
- 3.1.4.3 特定のデバイスをクエリする特定のデバイスの詳細情報を照会します。
- 3.1.4.4 デバイスのTSLモデルを照会するデバイスの TSL (Thing Specification Language) モデルをクエリします。
- 3.1.4.5 デバイス サービスを非同期に呼び出すデバイスのサービスを非同期で呼び出します。
- 3.1.4.5 プロパティ レポートの履歴データを照会するデバイスプロパティレポートの履歴データを照会するためのインターフェースについて紹介します。
- 3.1.4.6 デバイス情報の更新デバイスの名前、説明、およびタグを更新します。
- 3.1.4.7 デバイス プロパティを段階的に更新するデバイスのプロパティを段階的に更新します。これは、単一のデバイスおよび単純なパラメータの更新に適しています。
- 3.1.4.8 デバイスを削除するMilesight Development Platform からデバイスを削除します。
- 3.1.4.9 アプリケーションからデバイスを削除するMilesight Development Platform のアプリケーションからデバイスを削除します。
- 3.1.5.1 RPS用のプロファイルURLを指定するデバイスの RPS (リダイレクトおよびプロビジョニングサービス) でプロファイル URL を指定します。
- 3.1.5.2 クエリ プロファイル URL リスト現在のアプリケーション内のプロファイル URL リストを照会します。
- 3.1.5.3 デバイスのRPSレコードの削除RPS のプロファイル URL を指定してデバイスを Milesight Development Platform に追加する場合、またはデバイスを別のプラットフォームに転送する場合は、RPS レコードの一意性を確保するために、デバイスの現在の RPS レコードを削除する必要があります。
- 3.1.6.1 構成タスクの作成リモートデバイスに設定を適用するための設定タスクを作成します。これは、大量のデバイスや設定パラメータが多い場合に適しています。単一のデバイスや単純なパラメータの更新については、「デバイスプロパティの段階的な更新」を参照してください。
- 3.2.1 イベント通知の概要要件、Webhook ワークフロー、サポートされている Webhook イベントなど、Milesight Development Platform Webhook の概要について詳しく説明します。
- 3.2.2 Webhook イベント通知の設定サードパーティのアプリケーションが、デバイスが Milesight Development Platform にデータを報告したときにリアルタイムの通知を受け取ることができるように、Webhook イベント通知を設定する方法について説明します。
- 3.2.3.1 デバイスデータイベント「DEVICE_DATA」の例と説明について説明します。
- 3.2.3.2 タスクデータイベント「TASK_DATA」の例と詳細について説明します。