调用该接口根据申请批次ID(ApplyId)批量注册设备。
使用说明
批量注册设备有两种方式:
- 由系统随机生成设备名称:请调用BatchRegisterDevice接口。
-
自定义设备名称:需本接口与BatchCheckDeviceNames等接口结合实现。请按以下流程操作:
1. 调用BatchCheckDeviceNames接口,传入要批量注册的设备的名称。物联网平台检查您提交的设备名称符合要求后,返回申请批次ID(ApplyId)。ApplyId将用于设备名称设置结果查询、批量设备注册和设备信息查询。
2. 调用QueryBatchRegisterDeviceStatus查看名称设置结果。
3. 调用本接口批量注册设备。本接口调用返回的成功结果,仅表示批量注册的申请已经提交成功。实际的注册会有一个过程。
4. (可选)调用QueryBatchRegisterDeviceStatus查看设备注册结果。
5. 调用QueryPageByApplyId查看批量注册的设备信息。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为500。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | BatchRegisterDeviceWithApplyId |
系统规定参数。取值:BatchRegisterDeviceWithApplyId。 |
ApplyId | Long | 是 | 1295006 |
要批量注册的设备的申请批次ID。申请批次ID由调用BatchCheckDeviceNames接口生成。 |
ProductKey | String | 是 | a1BwAGV**** |
要批量注册的设备所属的产品ProductKey。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 注意
实例的更多信息,请参见实例概述。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.system.SystemException |
调用失败时,返回的错误码。更多信息,请参见错误码。 |
Data | Struct |
调用成功时,返回的数据,详情请参见以下参数。 |
|
ApplyId | Long | 1295006 |
申请批次ID。 |
ErrorMessage | String | 系统异常 |
调用失败时,返回的出错信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
表示是否调用成功。
|
示例
请求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=BatchRegisterDeviceWithApplyId
&ProductKey=alNdd3i****
&ApplyId=1234567
&<公共请求参数>
正常返回示例
XML
格式
<BatchRegisterDeviceWithApplyIdResponse>
<Data>
<ApplyId>1234567</ApplyId>
</Data>
<RequestId>82C16DC1-41B5-45F8-9AFD-1FB42448D405</RequestId>
<Success>true</Success>
</BatchRegisterDeviceWithApplyIdResponse>
JSON
格式
{
"Data": {
"ApplyId": 1234567
},
"RequestId": "82C16DC1-41B5-45F8-9AFD-1FB42448D405",
"Success": true
}
错误码
访问错误中心查看更多错误码。