Devices - Get Properties

  • 參考
Service:
IoT Central
API Version:
2022-07-31

取得裝置屬性
依裝置識別碼取得裝置的所有屬性值。

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}/properties?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

DeviceProperties

Success
Other Status Codes

Error

從 IoT Central 服務收到的錯誤回應。

Headers

x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

範例

Get properties

Sample Request

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

Sample Response

Status code:
200 
{
  "deviceinfo": {
    "manufacturer": "manufacturer",
    "$metadata": {
      "manufacturer": {
        "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
      },
      "model": {
        "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
      },
      "swVersion": {
        "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
      }
    },
    "model": "model",
    "swVersion": "swVersion"
  },
  "settings": {
    "fanSpeed": 12.5,
    "$metadata": {
      "fanSpeed": {
        "desiredValue": 30,
        "desiredVersion": 2,
        "lastUpdateTime": "2020-07-21T19:06:50.9718608Z"
      }
    }
  }
}

定義

名稱 Description
Error

回應錯誤定義。
ErrorDetails

錯誤的詳細資訊。

Error

回應錯誤定義。

名稱 類型 Description
error

ErrorDetails

目前要求的錯誤詳細數據。

ErrorDetails

錯誤的詳細資訊。

名稱 類型 Description
code

string

錯誤碼。
message

string

錯誤訊息詳細數據。
requestId

string

目前要求的相互關聯標識碼。
time

string

錯誤要求失敗的時間。