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

グループの詳細を照会します。

制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	QueryDeviceGroupInfo	実行する操作。値を QueryDeviceGroupInfo に設定します。
GroupId	String	はい	tDQvBJqbUyHs****	グループの ID。ID は、グループのグローバル一意識別子（GUID）です。 QueryDeviceGroupList 操作を呼び出して、GroupId パラメーターを照会できます。
IotInstanceId	String	いいえ	iot-cn-0pp1n8t****	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
GroupType	String	いいえ	LINK_PLATFORM_DYNAMIC	グループのタイプ。 LINK_PLATFORM_DYNAMIC に設定します。この値は動的グループを示します。このパラメーターを指定しないと、デフォルトで静的グループが照会されます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるグループの詳細。このパラメーターには、次のパラメーターが含まれます。
DeviceActive	Integer	1	アクティブ化されたデバイスの数。
DeviceCount	Integer	10	デバイスの総数。
DeviceOnline	Integer	0	オンラインデバイスの数。
DynamicGroupExpression	String	product_key = "a1***" and name LIKE "test%"	動的グループのルール。このパラメーターは、動的グループが照会された場合に返されます。
GroupDesc	String	usefulGroup	グループの説明。
GroupId	String	tDQvBJqbUyHs****	グループの ID。
GroupName	String	aliyun	グループの名前。
UtcCreate	String	2018-09-14T14:35:51.000Z	グループが作成された日時。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	7411716B-A488-4EEB-9AA0-6DB05AD2491F	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupInfo
&GroupId=tDQvBJqbUyHs****
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<QueryDeviceGroupInfoResponse>
<RequestId>7411716B-A488-4EEB-9AA0-6DB05AD2491F</RequestId>
<Data>
    <GroupName>aliyun</GroupName>
    <UtcCreate>2021-10-14T14:35:51.000Z</UtcCreate>
    <DeviceOnline>0</DeviceOnline>
    <GroupDesc>usefulGroup</GroupDesc>
    <DeviceActive>1</DeviceActive>
    <DynamicGroupExpression>product_key = "a1***" and name LIKE "test%"</DynamicGroupExpression>
    <DeviceCount>10</DeviceCount>
    <GroupId>tDQvBJqbUyHs****</GroupId>
</Data>
<Success>true</Success>
</QueryDeviceGroupInfoResponse>

JSON 形式

{
    "RequestId": "7411716B-A488-4EEB-9AA0-6DB05AD2491F",
    "Data": {
        "GroupName": "aliyun",
        "UtcCreate": "2021-10-14T14:35:51.000Z",
        "DeviceOnline": 0,
        "GroupDesc": "usefulGroup",
        "DeviceActive": 1,
        "DynamicGroupExpression": "product_key = \"a1***\" and name LIKE \"test%\"",
        "DeviceCount": 10,
        "GroupId": "tDQvBJqbUyHs****"
    },
    "Success": true
}

エラーコード

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