調用該介面添加裝置到某一分組(可大量新增裝置)。
QPS限制
單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為500。
說明 RAM使用者共用阿里雲帳號配額。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | BatchAddDeviceGroupRelations | 系統規定參數。取值:BatchAddDeviceGroupRelations。 |
| Device.N.DeviceName | String | 是 | ZHuPo6sZzv7pOzYh**** | 要添加到分組的裝置名稱,最多可傳入200個。 |
| Device.N.ProductKey | String | 是 | a1kORrK**** | 要添加到分組的裝置所屬的產品ProductKey,最多可傳入200個。 |
| GroupId | String | 是 | 6VfhebLg5iUe**** | 分組ID,分組的通用唯一識別碼。 |
| IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID。 重要
執行個體的更多資訊,請參見執行個體概述。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔。
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| AlreadyRelatedGroupDeviceCount | Integer | 0 | 原已經添加到此分組的裝置數量。 |
| Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼。 |
| ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯資訊。 |
| ExceedTenGroupDeviceCount | Integer | 0 | 請求參數中,已經添加到10個或者10個以上分組的裝置數量(一個裝置最多添加到10個分組)。 |
| RequestId | String | 671D0F8F-FDC7-4B12-93FA-336C079C965A | 阿里雲為該請求產生的唯一識別碼。 |
| Success | Boolean | true | 是否調用成功。
|
| SuccessAddedDeviceCount | Integer | 2 | 成功添加到分組的裝置數量。 |
| ValidDeviceCount | Integer | 2 | 請求參數中合法的裝置數量。 |
樣本
請求樣本
https://iot.cn-shanghai.aliyuncs.com/?Action=BatchAddDeviceGroupRelations
&Device.1.DeviceName=ZHuPo6sZzv7pOzYh****
&Device.1.ProductKey=a1kORrK****
&Device.2.DeviceName=rB4V9PDW2FCPmwuf****
&Device.2.ProductKey=a1kORrK****
&GroupId=6VfhebLg5iUe****
&<公用請求參數>
正常返回樣本
XML格式
<BatchAddDeviceGroupRelationsResponse>
<SuccessAddedDeviceCount>2</SuccessAddedDeviceCount>
<ExceedTenGroupDeviceCount>0</ExceedTenGroupDeviceCount>
<ErrorMessage>2 devices have been added, and 0 devices failed to be added.</ErrorMessage>
<ValidDeviceCount>2</ValidDeviceCount>
<AlreadyRelatedGroupDeviceCount>0</AlreadyRelatedGroupDeviceCount>
<RequestId>671D0F8F-FDC7-4B12-93FA-336C079C965A</RequestId>
<Success>true</Success>
</BatchAddDeviceGroupRelationsResponse>
JSON格式
{
"SuccessAddedDeviceCount":2,
"ExceedTenGroupDeviceCount":0,
"ErrorMessage":"2 devices have been added, and 0 devices failed to be added.",
"ValidDeviceCount":2,
"AlreadyRelatedGroupDeviceCount":0,
"RequestId":"671D0F8F-FDC7-4B12-93FA-336C079C965A",
"Success":true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。