調用該介面建立分組。
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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。