Modules - Invoke Method
デバイスのモジュールでダイレクト メソッドを呼び出します。 詳細については、「 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 パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
device
|
path | True |
string |
デバイスの一意識別子。 |
module
|
path | True |
string |
モジュールの一意の識別子。 |
api-version
|
query | True |
string |
Api のバージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
connectTimeoutInSeconds |
integer |
|
methodName |
string |
実行するメソッドの名前。 |
payload |
object |
JSON 形式のダイレクト メソッド ペイロード。最大 128 kb のサイズ。 |
responseTimeoutInSeconds |
integer |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK です。 |
定義
名前 | 説明 |
---|---|
Cloud |
デバイスでダイレクト メソッドを実行するパラメーター。 |
Cloud |
デバイス メソッドの呼び出し結果を表します。 |
CloudToDeviceMethod
デバイスでダイレクト メソッドを実行するパラメーター。
名前 | 型 | 説明 |
---|---|---|
connectTimeoutInSeconds |
integer |
|
methodName |
string |
実行するメソッドの名前。 |
payload |
object |
JSON 形式のダイレクト メソッド ペイロード。最大 128 kb のサイズ。 |
responseTimeoutInSeconds |
integer |
CloudToDeviceMethodResult
デバイス メソッドの呼び出し結果を表します。
名前 | 型 | 説明 |
---|---|---|
payload |
object |
メソッド呼び出しの結果ペイロード。 |
status |
integer |
メソッド呼び出しの結果の状態。 |