Modules - Invoke Method

Service:

IoT Hub

API Version:

2021-04-12

在裝置的模組上叫用直接方法。 如需相關資訊，請參閱 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods 。

POST https://fully-qualified-iothubname.azure-devices.net/twins/{deviceId}/modules/{moduleId}/methods?api-version=2021-04-12

URI 參數

名稱	位於	必要	類型	Description
deviceId	path	True	string	裝置的唯一識別碼。
moduleId	path	True	string	模組的唯一識別碼。
api-version	query	True	string	Api 的版本。

要求本文

名稱	類型	Description
connectTimeoutInSeconds	integer
methodName	string	要執行的方法名稱。
payload	object	JSON 格式的直接方法承載，大小上限為 128 kb。
responseTimeoutInSeconds	integer

回應

名稱	類型	Description
200 OK	CloudToDeviceMethodResult	正常。

定義

名稱	Description
CloudToDeviceMethod	在裝置上執行直接方法的參數。
CloudToDeviceMethodResult	表示 Device 方法調用結果。

CloudToDeviceMethod

在裝置上執行直接方法的參數。

名稱	類型	Description
connectTimeoutInSeconds	integer
methodName	string	要執行的方法名稱。
payload	object	JSON 格式的直接方法承載，大小上限為 128 kb。
responseTimeoutInSeconds	integer

CloudToDeviceMethodResult

表示 Device 方法調用結果。

名稱	類型	Description
payload	object	方法調用結果承載。
status	integer	方法調用結果狀態。