特定のデバイスの詳細な設定を照会します。
リクエスト URL
GET {base_url}/device/openapi/v1/devices/{deviceId}/config
リクエストパラメータ
パラメータ | 必須 | タイプ | 説明 |
---|---|---|---|
Authorization | Yes | String | API 呼び出しを行うための有効なアクセストークン。
形式は Bearer {access_token} である必要があります。 |
パラメータ | 必須 | タイプ | 説明 |
---|---|---|---|
deviceId | Yes | Long | このデバイスの一意のID。デバイスを追加した際に返されるIDです。
注:デバイス ID を保存していない場合は、特定のデバイスを検索を使用してデバイスの ID を照会できます。 |
応答パラメータ
パラメータ | タイプ | 説明 |
---|---|---|
data | Object<Device_Config> | 照会したデバイスの詳細な設定。 |
status | String | API リクエストの結果。
|
requestId | String | リクエストの一意の ID。リクエストをすばやく見つけるために使用できます。 |
- Device_Config
-
パラメータ タイプ 説明 version String - このデバイスの設定ファイルのバージョン
type String - TSL 設定ファイルを使用する場合にのみ表示されます
properties String - TSL 設定デバイスにのみ表示されます。プロパティの内容については、設定プロパティを参照してください
values String - プロファイル設定デバイスにのみ表示されます。プロファイルの内容については、デフォルトのプロファイルテンプレートまたはカスタム設定テンプレートの作成を参照してください。
例
- リクエスト例
-
- ID 「1739930666380779522」 のデバイスの詳細情報を取得します
-
GET /device/openapi/v1/devices/1739930666380779522/config HTTP/1.1 Host: demo.milesight.com Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InllYXN0b25lLWRlZmF1bHQta2V5LWlkIn0.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsib3BlbmFwaSJdLCJjbGllbnRfZXh0Ijp7ImFwcF9pZCI6IjE3MzY5NTQ4MDE3MTMzMjgxMzAifSwiZXhwIjoxNzAzMjEzMDk4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJiYjJjN2U4Yy03NGQwLTQ4NjEtODE3MS1iYTc0NWRlMGY0NmQiLCJjbGllbnRfaWQiOiI4OTNkNzdjNy1mMGNiLTRmMzQtOWNhMS03YzJhNGNmMTEzNDgiLCJ0cyI6MTcwMzIwOTQ5ODMzNH0 Content-Type: application/json
- レスポンス例
-
HTTP/1.1 200 OK { "data": { "version": "v1.2", "values": [ { "key": "dm_enable", "value": 1 }, { "key": "dm_type", "value": 0 }, { "key": "dm_mip_addr", "value": "https://milesight.com/device" }, { "key": "dm_dh_addr", "value": "" }, { "key": "autop_enable", "value": 1 }, { "key": "scene_prvw", "value": 0 }, { "key": "image_type", "value": 1 }, { "key": "show_track_line", "value": 1 }, { "key": "show_detect_line", "value": 1 }, { "key": "show_uturn_area", "value": 1 }, { "key": "show_detect_region", "value": 1 }, { "key": "show_shopping_cart", "value": 0 }, { "key": "work_mode", "value": 0 }, { "key": "install_height", "value": 3000 }, { "key": "max_target_height", "value": 2000 }, { "key": "min_target_height", "value": 1000 }, { "key": "child_filt_height", "value": 1300 }, { "key": "cart_full_height", "value": 750 }, { "key": "cart_empty_height", "value": 450 }, { "key": "track_mode", "value": 0 }, { "key": "person_detect_mode", "value": 0 }, { "key": "child_diff", "value": 0 }, { "key": "staff_detect", "value": 0 }, { "key": "staff_sensitivity", "value": 5 }, { "key": "group_count", "value": 0 }, { "key": "max_group_count", "value": 20 }, { "key": "shopping_cart_detect_en", "value": 0 }, { "key": "heatmap", "value": 0 }, { "key": "uturn_filter", "value": 1 }, { "key": "region_monitor", "value": 0 }, { "key": "rst_cum_count", "value": 0 }, { "key": "rst_day", "value": 7 }, { "key": "rst_time", "value": 0 }, { "key": "input_enable_count", "value": 0 }, { "key": "trig_stat", "value": 0 }, { "key": "digital_output_en", "value": 1 }, { "key": "sync_pulse_interval", "value": 100 }, { "key": "adults_in_pulse_en", "value": 0 }, { "key": "adults_in_pulse_width", "value": 100 }, { "key": "adults_out_pulse_en", "value": 0 }, { "key": "adults_out_pulse_width", "value": 200 }, { "key": "children_in_pulse_en", "value": 0 }, { "key": "children_in_pulse_width", "value": 300 }, { "key": "children_out_pulse_en", "value": 0 }, { "key": "children_out_pulse_width", "value": 400 }, { "key": "staff_in_pulse_en", "value": 0 }, { "key": "staff_in_pulse_width", "value": 500 }, { "key": "staff_out_pulse_en", "value": 0 }, { "key": "staff_out_pulse_width", "value": 600 }, { "key": "group_in_pulse_en", "value": 0 }, { "key": "group_in_pulse_width", "value": 700 }, { "key": "group_out_pulse_en", "value": 0 }, { "key": "group_out_pulse_width", "value": 800 }, { "key": "manual_pulse_en", "value": 1 }, { "key": "manual_pulse_width", "value": 5000 }, { "key": "ip_assign", "value": 1 }, { "key": "ip_addr", "value": "192.168.5.220" }, { "key": "subnet_mask", "value": "255.255.255.0" }, { "key": "default_gateway", "value": "192.168.5.1" }, { "key": "prim_dns_server", "value": "8.8.8.8" }, { "key": "second_dns_server", "value": "114.114.114.114" }, { "key": "http_enable", "value": 1 }, { "key": "http_port", "value": 80 }, { "key": "https_port", "value": 443 }, { "key": "dot1x_enable", "value": 0 }, { "key": "dot1x_auth_type", "value": 0 }, { "key": "dot1x_eapol", "value": 0 }, { "key": "dot1x_identity", "value": "" }, { "key": "dot1x_password", "value": "" }, { "key": "dot1x_ca_cert", "value": "", "fileSize": "", "md5": "", "crc32": "" }, { "key": "dot1x_client_cert", "value": "", "fileSize": "", "md5": "", "crc32": "" }, { "key": "dot1x_private_key", "value": "", "fileSize": "", "md5": "", "crc32": "" }, { "key": "dot1x_private_passwd", "value": "" }, { "key": "recipient", "value": "" }, { "key": "dev_name", "value": "People Counter" }, { "key": "cus_dev_id", "value": "" }, { "key": "cus_site_id", "value": "" }, { "key": "time_zone", "value": 14 }, { "key": "dst_enable", "value": 0 }, { "key": "dst_start_month", "value": 3 }, { "key": "dst_start_week_no", "value": 5 }, { "key": "dst_start_week_day", "value": 0 }, { "key": "dst_start_time", "value": 120 }, { "key": "dst_end_month", "value": 10 }, { "key": "dst_end_week_no", "value": 5 }, { "key": "dst_end_week_day", "value": 0 }, { "key": "dst_end_time", "value": 180 }, { "key": "dst_bias_time", "value": 60 }, { "key": "sync_mode", "value": 1 }, { "key": "ntp_server_addr", "value": "pool.ntp.org" }, { "key": "ntp_syn_interval", "value": 1440 }, { "key": "ssh_enable", "value": 1 }, { "key": "tof_freq_adjust", "value": 0 }, { "key": "tof_light_mode", "value": 2 }, { "key": "schedule_start_time", "value": 32400 }, { "key": "schedule_end_time", "value": 79200 }, { "key": "confidence_switch", "value": 0 }, { "key": "confidence_value", "value": 2 }, { "key": "hard_rst", "value": 0 } ] }, "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」の例と詳細について説明します。