NotifyAddThingTopo - IoT Platform - Alibaba Cloud ドキュメントセンター

ゲートウェイにトポロジー関係を追加するように通知します。

使用方法

正常な応答は、トポロジー関係を追加するコマンドがゲートウェイに送信されたことを示します。トポロジー関係が追加されたことを示すものではありません。

ゲートウェイを開発する場合は、トポロジー関係を追加するときに通知を送信するために使用される [Topic] をサブスクライブする必要があります。 [Topic] およびメッセージ形式の詳細については、「トポロジー関係を管理する」をご参照ください。

制限

Alibaba Cloud アカウントごとに、最大 500 クエリ/秒（QPS）を実行できます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。 OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメータ

パラメータ	タイプ	必須	例	説明
Action	String	はい	NotifyAddThingTopo	実行する操作。値を NotifyAddThingTopo に設定します。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。IoT Platform コンソールの [概要] ページでインスタンスの [ID] を確認できます。重要インスタンスに ID がある場合は、このパラメータを設定する必要があります。このパラメータを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメータを設定する必要はありません。詳細については、「概要」をご参照ください。
DeviceListStr	String	いいえ	[{"productKey":"a1BwAGV**","deviceName":"device1"},{"IotId":"Q7uOhVRdZRRlDnTLv**00100"}]	サブデバイス ID 情報の JSON 配列。ProductKey と DeviceName の組み合わせ、または IotId のみを使用して、[{"productKey":"a1BwAGxxx","deviceName":"device1"},{"IotId":"Q7uOhxxx"}] のようにデバイスを指定できます。
GwIotId	String	いいえ	vWxNur6BUApsqjv****4000100	ゲートウェイデバイスの ID。 ID は、IoT Platform がデバイスに発行する一意の識別子です。説明このパラメータを指定する場合、プロダクトキーまたは DeviceName を指定する必要はありません。 IotId パラメータは、デバイスのグローバル一意識別子（GUID）を指定します。これは、プロダクトキーと DeviceName の組み合わせに対応します。 IotId とプロダクトキーと DeviceName の組み合わせの両方を指定した場合、IoT ID が優先されます。
GwProductKey	String	いいえ	a1T27vz****	ゲートウェイが属するプロダクトの ProductKey。説明このパラメータを指定する場合は、DeviceName パラメータも指定する必要があります。
GwDeviceName	String	いいえ	gateway	ゲートウェイの DeviceName。説明このパラメータを指定する場合は、プロダクトキーパラメータも指定する必要があります。

上記の操作固有のリクエストパラメータに加えて、この操作を呼び出すときは、共通のリクエストパラメータを指定する必要があります。詳細については、「共通リクエストパラメータ」をご参照ください。

レスポンスパラメータ

パラメータ	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるデータ。
MessageId	String	5443123	IoT Platform がゲートウェイに送信するメッセージの ID。このメッセージは、ゲートウェイにトポロジーを追加するように通知するために使用されます。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=NotifyAddThingTopo
&GwProductKey=aldnfald7a
&GwDeviceName=gateway
&DeviceListStr=[{"productKey":"alabcabcab","deviceName":"device1"},{"IotId":"edAjkIeBSsdfadjjllja***"}]
&<共通リクエストパラメータ>

成功レスポンスの例

XML 形式

<NotifyAddThingTopoResponse>
  <RequestId>419A3FC1-B517-4958-9414-5546765FA51F</RequestId>
  <Success>true</Success>
  <Data>
        <MessageId>2345123</MessageId>
  </Data>
</NotifyAddThingTopoResponse>

JSON 形式

{
  "RequestId":"419A3FC1-B517-4958-9414-5546765FA51F",
  "Success": true,
  "Data": {
     "MessageId": "2345123"
  }
}

エラーコード

エラーコードのリストについては、API エラーセンターをご参照ください。