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

デバイスが属するグループをクエリします。

制限

1 つのデバイスを最大 10 個のグループに追加できます。
各 Alibaba Cloud アカウントは、最大 50 クエリ/秒（QPS）を実行できます。
説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	QueryDeviceGroupByDevice	実行する操作。値を QueryDeviceGroupByDevice に設定します。
DeviceName	String	はい	test456	デバイスの DeviceName。
ProductKey	String	はい	a1SKk9K****	デバイスが属するプロダクトの ProductKey。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
GroupInfos	GroupInfo の配列		呼び出しが成功した場合に返されるグループ情報。詳細については、以下の GroupInfo パラメーターをご参照ください。
GroupInfo
GroupDesc	String	father desc	グループの説明。
GroupId	String	6a3FF2XE2BKa****	グループの ID。
GroupName	String	father1543152336554	グループの名前。
GroupType	String	LINK_PLATFORM_DYNAMIC	グループのタイプ。
UtcCreate	String	2018-11-25T13:25:37.000Z	グループが作成された日時。
RequestId	String	7941C8CD-7764-4A94-8CD9-E2762D4A73AC	リクエストの ID。
Success	ブール値	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupByDevice
&DeviceName=test456
&ProductKey=a1SKk9K****
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<QueryDeviceGroupByDeviceResponse>
  <RequestId>7941C8CD-7764-4A94-8CD9-E2762D4A73AC</RequestId>
  <GroupInfos>
        <GroupInfo>
              <GroupDesc>father desc</GroupDesc>
              <GroupName>father1543152336554</GroupName>
              <UtcCreate>2018-11-25T13:25:37.000Z</UtcCreate>
              <GroupId>6a3FF2XE2BKa***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
  </GroupInfos>
  <Success>true</Success>
</QueryDeviceGroupByDeviceResponse>

JSON 形式

{
  "RequestId": "7941C8CD-7764-4A94-8CD9-E2762D4A73AC",
  "GroupInfos": {
    "GroupInfo": [
      {
        "GroupDesc": "father desc",
        "GroupName": "father1543152336554",
        "UtcCreate": "2018-11-25T13:25:37.000Z",
        "GroupId": "6a3FF2XE2BKa***",
        "GroupType":"LINK_PLATFORM_DYNAMIC"
      }
    ]
  },
  "Success": true
}

エラーコード

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