Devices - Get

服務:

IoT Central

API 版本:

2022-07-31

依識別碼取得裝置
依裝置識別碼取得現有裝置的詳細數據。

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}?api-version=2022-07-31

URI 參數

名稱	位於	必要	類型	Description
baseDomain	path	True	string	所有 Azure IoT Central 服務要求的基底網域。
deviceId	path	True	string	裝置的唯一標識碼。
subdomain	path	True	string	應用程式子域。
api-version	query	True	string	所呼叫之 API 的版本。

回應

名稱	類型	Description
200 OK	Device	Success
Other Status Codes	Error	從 IoT Central 服務收到的錯誤回應。 標題 x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get device by ID

範例要求

HTTP

GET https://appsubdomain.azureiotcentral.com/api/devices/CheckoutThermostat?api-version=2022-07-31

範例回覆

狀態碼:

200

{
  "id": "CheckoutThermostat",
  "etag": "eyJoZWFkZXIiOiJcIjAyMDA4YzMyLTAwMDAtMGQwMC0wMDAwLTVkOTY4YjdhMDAwMFwiIn0",
  "displayName": "CheckoutThermostat",
  "template": "dtmi:contoso:testDeviceTemplate;1",
  "simulated": true,
  "provisioned": true,
  "enabled": true,
  "organizations": [
    "seattle"
  ]
}

定義

名稱	Description
Device	裝置定義。
Error	回應錯誤定義。
ErrorDetails	錯誤的詳細資訊。

Device

裝置定義。

名稱	類型	Description
displayName	string	裝置的顯示名稱。
enabled	boolean	是否已啟用與IoT Central的裝置連線。
etag	string	用來防止裝置更新衝突的 ETag。
id	string	裝置的唯一標識碼。
organizations	string[]	裝置所屬的組織標識碼清單，目前僅支援一個組織，即將支援多個組織。
provisioned	boolean	是否已為裝置配置資源。
simulated	boolean	裝置是否模擬。
template	string	裝置的裝置範本定義。

Error

回應錯誤定義。

名稱	類型	Description
error	ErrorDetails	目前要求的錯誤詳細數據。

ErrorDetails

錯誤的詳細資訊。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息詳細數據。
requestId	string	目前要求的相互關聯標識碼。
time	string	錯誤要求失敗的時間。