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

サブデバイス情報に基づいて、ゲートウェイの情報を照会します。

制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	GetGatewayBySubDevice	実行する操作。値を GetGatewayBySubDevice に設定します。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
ProductKey	String	No	a1BwAGV****	デバイスが属するプロダクトの ProductKey。説明このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。
DeviceName	String	No	light	サブデバイスの DeviceName。説明このパラメーターを指定する場合は、ProductKey パラメーターも指定する必要があります。
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	サブデバイスの ID。この ID は、IoT Platform がサブデバイスに発行する一意の識別子です。説明このパラメーターを指定する場合は、ProductKey または DeviceName を指定する必要はありません。 IotId パラメーターは、デバイスのグローバル一意識別子（GUID）を指定します。これは、ProductKey と DeviceName の組み合わせに対応します。 IotId と ProductKey と DeviceName の組み合わせの両方を指定した場合、IotId が優先されます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるゲートウェイの詳細。
DeviceName	String	gateway	ゲートウェイの DeviceName。
DeviceSecret	String	dCYdTU3gw5Z77bsHjPk6lPHPVnBT****	ゲートウェイの DeviceSecret。
FirmwareVersion	String	V1.0.1	デバイスのファームウェアバージョン番号。
GmtActive	String	2019-12-18 23:25:30	ゲートウェイのアクティブ化時刻。時刻は GMT で表示されます。時刻は、ゲートウェイが存在するリージョンのローカル時刻です。
GmtCreate	String	2019-12-18 16:58:33	ゲートウェイの作成時刻。時刻は GMT で表示されます。時刻は、ゲートウェイが存在するリージョンのローカル時刻です。
GmtOnline	String	2020-01-20 17:41:04	ゲートウェイの最終オンライン時刻。時刻は GMT で表示されます。時刻は、ゲートウェイが存在するリージョンのローカル時刻です。
IpAddress	String	106..1.**	ゲートウェイの IP アドレス。
NodeType	String	1	ノードタイプ。値 1 は、デバイスがゲートウェイであることを示します。
ProductKey	String	a1BwAGV****	ゲートウェイが属するプロダクトの ProductKey。
ProductName	String	LinkIoT	ゲートウェイが属するプロダクトの名前。
Status	String	online	ゲートウェイデバイスのステータス。有効な値： online: デバイスはオンラインです。 offline: デバイスはオフラインです。 unactive: デバイスはアクティブ化されていません。 disable: デバイスは無効になっています。
UtcActive	String	2019-12-18T15:25:30.176Z	ゲートウェイのアクティブ化時刻。時刻は UTC で表示されます。ゲートウェイが存在するリージョンの実際の時間は、リージョンのタイムゾーンに基づいて計算されます。
UtcCreate	String	2019-12-18T08:58:33.000Z	ゲートウェイの作成時刻。時刻は UTC で表示されます。ゲートウェイが存在するリージョンの実際の時間は、リージョンのタイムゾーンに基づいて計算されます。
UtcOnline	String	2020-01-20T09:41:04.879Z	ゲートウェイの最終オンライン時刻。時刻は UTC で表示されます。ゲートウェイが存在するリージョンの実際の時間は、リージョンのタイムゾーンに基づいて計算されます。
iotId	String	WuyjPSDQE1L22z1d****000100	ゲートウェイデバイスの ID。この ID は、IoT Platform がデバイスに発行する一意の識別子です。
region	String	cn-shanghai	ゲートウェイが存在するリージョン。このリージョンは、IoT Platform コンソールに表示されるリージョンに対応します。
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=GetGatewayBySubDevice
&ProductKey=a1BwAGV****
&DeviceName=XTzosqEOgxFXKPRgd8zl
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<GetGatewayBySubDeviceResponse>
  <Data>
        <region>cn-shanghai</region>
        <DeviceName>gateway_04</DeviceName>
        <GmtActive>2019-12-18 23:25:30</GmtActive>
        <ProductKey>a1vL7cp****</ProductKey>
        <IpAddress>106.**.1**.**</IpAddress>
        <GmtCreate>2019-12-18 16:58:33</GmtCreate>
        <UtcCreate>2019-12-18T08:58:33.000Z</UtcCreate>
        <UtcOnline>2020-01-20T09:41:04.879Z</UtcOnline>
        <UtcActive>2019-12-18T15:25:30.176Z</UtcActive>
        <Status>online</Status>
        <NodeType>1</NodeType>
        <GmtOnline>2020-01-20 17:41:04</GmtOnline>
        <ProductName>LinkIoTEdge_Gateway</ProductName>
        <iotId>WuyjPSDQE1L22z1****000100</iotId>
  </Data>
  <RequestId>0377D5A9-BDE1-48C2-96C9-BDC048899186</RequestId>
  <Success>true</Success>
</GetGatewayBySubDeviceResponse>

JSON 形式

{
    "Data": {
        "region": "cn-shanghai",
        "DeviceName": "gateway_04",
        "GmtActive": "2019-12-18 23:25:30",
        "ProductKey": "a1vL7cp****",
        "IpAddress": "106.**.1**.**",
        "GmtCreate": "2019-12-18 16:58:33",
        "UtcCreate": "2019-12-18T08:58:33.000Z",
        "UtcOnline": "2020-01-20T09:41:04.879Z",
        "UtcActive": "2019-12-18T15:25:30.176Z",
        "Status": "online",
        "NodeType": 1,
        "GmtOnline": "2020-01-20 17:41:04",
        "ProductName": "LinkIoTEdge_Gateway",
        "iotId": "WuyjPSDQE1L22z1****000100"
    },
    "RequestId": "0377D5A9-BDE1-48C2-96C9-BDC048899186",
    "Success": true
}

エラーコード

エラーコードの一覧については、「API エラーセンター」をご参照ください。