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

グループを作成します。

制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	CreateDeviceGroup	実行する操作。値を CreateDeviceGroup に設定します。
GroupName	String	はい	grouptest	グループの名前。エイリアスは 4 ～ 30 文字で、文字、数字、およびアンダースコア（_）を含めることができます。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
SuperGroupId	String	いいえ	SuperGroupId1	親グループの ID。第 1 レベルのグループを作成する必要がある場合は、このパラメーターを指定しないでください。
GroupDesc	String	いいえ	Group test	グループの説明。説明は 1 ～ 100 文字である必要があります。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるグループ情報。
GroupDesc	String	Group test	各グループの説明。
GroupId	String	HtMLECKbdJQL****	グループの ID。ID は、システムがグループに対して生成するグローバル一意識別子（GUID）です。
GroupName	String	grouptest	グループの名前。
UtcCreate	String	2018-10-17T11:19:31.000Z	グループが作成された日時。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	4D6D7F71-1C94-4160-8511-EFF4B8F0634D	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateDeviceGroup
&GroupDesc=Group test
&GroupName=grouptest
&<Common request parameters>

成功レスポンスの例

XML 形式

<CreateDeviceGroupResponse>
      <Data>
            <GroupDesc>Group test</GroupDesc>
            <GroupName>grouptest</GroupName>
            <UtcCreate>2018-10-17T11:19:31.000Z</UtcCreate>
            <GroupId>HtMLECKbdJQL****</GroupId>
      </Data>
      <RequestId>4D6D7F71-1C94-4160-8511-EFF4B8F0634D</RequestId>
      <Success>true</Success>
</CreateDeviceGroupResponse>

JSON 形式

{
    "Data":{
        "GroupDesc":"Group test",
        "GroupName":"grouptest",
        "UtcCreate":"2018-10-17T11:19:31.000Z",
        "GroupId":"HtMLECKbdJQL****"
    },
    "RequestId":"4D6D7F71-1C94-4160-8511-EFF4B8F0634D",
    "Success":true
}

エラーコード

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