調用該接口新建分組。
QPS限制
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為500。
說明 RAM用戶共享阿里云賬號配額。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateDeviceGroup |
系統規定參數。取值:CreateDeviceGroup。 |
GroupName | String | 是 | grouptest |
分組名稱。名稱長度為4~30個字符,可包含中文漢字、英文字母、數字和下劃線(_)。一個中文漢字占兩個字符。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID。 注意
實例的更多信息,請參見實例概述。 |
SuperGroupId | String | 否 | SuperGroupId1 |
父組ID。 若要創建的是一級分組,則不傳入此參數。 |
GroupDesc | String | 否 | Group test |
分組描述。長度不超過100個字符,一個中文漢字占一個字符。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.system.SystemException |
調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
Data | Struct |
調用成功時,返回的分組信息。 |
|
GroupDesc | String | Group test |
分組描述。 |
GroupId | String | HtMLECKbdJQL**** |
分組ID,系統為分組生成的全局唯一標識符。 |
GroupName | String | grouptest |
分組名稱。 |
UtcCreate | String | 2018-10-17T11:19:31.000Z |
創建時間。 |
ErrorMessage | String | 系統異常 |
調用失敗時,返回的出錯信息。 |
RequestId | String | 4D6D7F71-1C94-4160-8511-EFF4B8F0634D |
阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true |
是否調用成功。
|
示例
請求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=CreateDeviceGroup
&GroupDesc=Group test
&GroupName=grouptest
&<公共請求參數>
正常返回示例
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
}