Registers multiple devices by using an application ID at a time.
Usage notes
You can use one of the following methods to register multiple devices at a time:
- Call the BatchRegisterDevice operation to generate random DeviceNames.
-
Call the BatchRegisterDeviceWithApplyId and BatchCheckDeviceNames operations to specify custom DeviceNames. Procedure:
Call the BatchCheckDeviceNames operation and specify the names of devices that you want to register. If the DeviceNames are valid, IoT Platform returns an application ID that is specified by the ApplyId parameter. You can query the DeviceName setting results, device registration results, and device details by ApplyId.
Call the QueryBatchRegisterDeviceStatus operation to query the name setting result.
Call the BatchRegisterDeviceWithApplyId operation to register multiple devices. The successful result that is returned by this operation indicates that only the batch registration request is submitted. In actual scenarios, the registration process takes a few minutes.
Optional. Call the QueryBatchRegisterDeviceStatus operation to query the device registration result.
Call the QueryPageByApplyId operation to view the details of devices that are registered in batches.
QPS limits
Each Alibaba Cloud account can run up to 500 queries per second (QPS).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | BatchRegisterDeviceWithApplyId |
The operation that you want to perform. Set the value to BatchRegisterDeviceWithApplyId. |
ApplyId | Long | Yes | 1295006 |
The ID of the application. The application ID is returned by the BatchCheckDeviceNames operation. |
ProductKey | String | Yes | a1BwAGV**** |
The ProductKey of the product to which the device belongs. |
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** |
The ID of the instance. You can view the ID of the instance on the Overview page in the IoT Platform console. Notice
For more information, see Overview. |
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | iot.system.SystemException |
The error code returned if the call fails. For more information, see Error codes. |
Data | Struct |
The data returned if the call succeeds. For more information, see the following parameters. |
|
ApplyId | Long | 1295006 |
The application ID. |
ErrorMessage | String | A system exception occurred. |
The error message returned if the request fails. |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful.
|
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=BatchRegisterDeviceWithApplyId
&ProductKey=alNdd3i****
&ApplyId=1234567
&<Common request parameters>
Sample success responses
XML
format
<BatchRegisterDeviceWithApplyIdResponse>
<Data>
<ApplyId>1234567</ApplyId>
</Data>
<RequestId>82C16DC1-41B5-45F8-9AFD-1FB42448D405</RequestId>
<Success>true</Success>
</BatchRegisterDeviceWithApplyIdResponse>
JSON
format
{
"Data": {
"ApplyId": 1234567
},
"RequestId": "82C16DC1-41B5-45F8-9AFD-1FB42448D405",
"Success": true
}