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

指定されたゲートウェイデバイスのサブデバイスをクエリします。

制限

各 Alibaba Cloud アカウントは、最大 500 クエリ/秒（QPS）を開始できます。

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

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	GetThingTopo	実行する操作。値を GetThingTopo に設定します。
PageNo	Integer	Yes	1	返すページ番号。
PageSize	Integer	Yes	10	各ページに返すエントリの数。最大値：50。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	IoT（Internet of Things）サービスインスタンスの ID。このパラメーターは、パブリックインスタンスには必要ありません。ただし、エンタープライズ版インスタンスにはこのパラメーターが必要です。
ProductKey	String	No	a1BwAGV****	ゲートウェイデバイスが属するプロダクトの ProductKey。説明このパラメーターを指定する場合は、DeviceName パラメーター。
DeviceName	String	No	light	ゲートウェイデバイスの名前。説明このパラメーターを指定する場合は、プロダクトキーパラメーター。
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	ゲートウェイデバイスの ID。この ID は、IoT Platform がゲートウェイデバイスに発行する一意の識別子です。説明このパラメーターを指定する場合は、パラメーターまたはパラメーターを指定する必要はありません。パラメーターはデバイスの一意の識別子を指定し、パラメーターとパラメーターの組み合わせに対応します。パラメーターとパラメーターとパラメーターの組み合わせを同時に指定した場合、パラメーターが優先されます。プロダクトキーまたは DeviceName パラメーター。IotIdパラメーターは、デバイスの一意の識別子を指定し、プロダクトキーおよび DeviceName パラメーター。指定した場合、IotId パラメーターとプロダクトキーおよび DeviceName パラメーターを同時に IoT ID パラメーターが優先されます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコードです。詳細については、「エラーコード。
Data	Struct		呼び出しが成功した場合に返されるデータ。詳細については、以下のパラメーターを参照してください。
CurrentPage	Integer	1	返されたページのページ番号。
List	deviceInfo の配列		サブデバイスの詳細。パラメーターにサブデバイスの詳細が含まれています。デバイス情報パラメーター。
deviceInfo
DeviceName	String	light	サブデバイスの DeviceName。
IotId	String	Q7uOhVRdZRRlDnTLv****00100	サブデバイスの ID。この ID は、IoT Platform がサブデバイスに発行する一意の識別子です。
ProductKey	String	a1BwAGV****	サブデバイスが属するプロダクトの ProductKey。
PageCount	Long	1	返されるページの総数。
PageSize	Integer	10	各ページに返されるエントリの数。
Total	Long	1	返されるエントリの総数。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true：呼び出しは成功しました。 false：呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=GetThingTopo
&ProductKey=a1BwAGV****
&DeviceName=device1
&PageSize=10
&PageNo=1
&<Common request parameters>

成功レスポンスの例

XML 形式

<GetThingTopoResponse>
  <Data>
        <PageCount>1</PageCount>
        <PageSize>2</PageSize>
        <CurrentPage>1</CurrentPage>
        <List>
              <deviceInfo>
                    <DeviceName>APItest</DeviceName>
                    <ProductKey>a1T27vz****</ProductKey>
                    <IotId>vWxNur6BUApsqjv****000100</IotId>
              </deviceInfo>
        </List>
        <Total>1</Total>
  </Data>
  <RequestId>93F05C63-9FD1-4CC8-B0FF-6D6C1A6632D1</RequestId>
  <Success>true</Success>
</GetThingTopoResponse>

JSON 形式

{
	"Data": {
		"PageCount": 1,
		"PageSize": 2,
		"CurrentPage": 1,
		"List": {
			"deviceInfo": [
				{
					"DeviceName": "APItest",
					"ProductKey": "a1T27vz****",
					"IotId": "vWxNur6BUApsqjv****000100"
				}
			]
		},
		"Total": 1
	},
	"RequestId": "93F05C63-9FD1-4CC8-B0FF-6D6C1A6632D1",
	"Success": true
}

エラーコード

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