调用该接口查询批量注册设备申请的处理状态和结果。
使用说明
批量注册设备时,可调用本接口根据申请批次ID(ApplyId),查看设备名称校验结果或注册结果。
使用自定义设备名称批量注册设备时,必须先调用本接口确保自定义设备名称全部校验通过,再调用BatchRegisterDeviceWithApplyId接口根据对应申请批次ID完成设备注册。
- 如果有校验失败的设备名称,请根据错误信息提示进行修正,然后重新调用BatchCheckDeviceNames接口获取新的申请批次ID(ApplyId)后,再次调用QueryBatchRegisterDeviceStatus接口确认全部设备名称校验通过。
- 如果返回的Status为CHECK,请耐心等待。批量注册设备有一个过程,您可再次调用本接口查看Status确认全部设备名称校验通过。
使用自定义设备名称批量注册设备的完整流程,请参见BatchCheckDeviceNames的使用说明。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为30。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | QueryBatchRegisterDeviceStatus | 系统规定参数。取值:QueryBatchRegisterDeviceStatus。 |
ApplyId | Long | 是 | 1295006 | 要查询的申请批次ID。 申请批次ID在成功调用BatchCheckDeviceNames或BatchRegisterDevice接口的返回结果中。 |
ProductKey | String | 是 | a1BwAGV**** | 要查询的设备所属的产品ProductKey。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 重要
实例的更多信息,请参见实例概述。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 |
类型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 调用失败时,返回的错误码。更多信息,请参见错误码。 说明 目前仅华东2(cn-shanghai)地域支持设备X.509证书,如果地域不是华东2(cn-shanghai),则不能生成X.509证书,返回错误码iot.device.RegionNotSupportX509。 |
Data | Struct | 调用成功时,返回的状态信息。 |
|
InvalidDetailList | Array of invalidDetailList |
|
|
invalidDetailList | |||
DeviceName | String | light | 设备名称。 |
ErrorMsg | String | The nick name is illegal. | 创建设备失败,返回的出错信息。 说明 多个出错信息间使用竖线(|)隔开。 |
NickName | String | 园区灯-1 | 设备的备注名称。 |
InvalidList | List | { "Name": ["Elec_instrument"] } |
|
Status | String | CREATE_SUCCESS | 申请单的处理状态和结果,取值:
|
ValidList | List | { "Name": ["light3"] } |
|
ErrorMessage | String | 系统异常 | 调用失败时,返回的出错信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 表示是否调用成功。
|
示例
请求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryBatchRegisterDeviceStatus
&ProductKey=a1BwAGV****
&ApplyId=1234567
&<公共请求参数>
正常返回示例
XML
格式
<QueryBatchCheckDeviceNamesStatusResponse>
<RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
<Data>
<Status>CREATE_SUCCESS</Status>
<InvalidDetailList>
<invalidDetailList>
<ErrorMsg>The nick name is illegal. | The nick name is illegal.</ErrorMsg>
<NickName>园区灯-1</NickName>
<DeviceName>Elec_instrument</DeviceName>
</invalidDetailList>
</InvalidDetailList>
<ValidList>
<Name>light3</Name>
</ValidList>
<InvalidList>
<Name>Elec_instrument</Name>
</InvalidList>
</Data>
<Code></Code>
<Success>true</Success>
</QueryBatchCheckDeviceNamesStatusResponse>
JSON
格式
{
"RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
"Data": {
"Status": "CREATE_SUCCESS",
"InvalidDetailList": {
"invalidDetailList": [{
"ErrorMsg": "The nick name is illegal. | The nick name is illegal.",
"NickName": "园区灯-1",
"DeviceName": "Elec_instrument"
}]
},
"ValidList": {
"Name": ["light3"]
},
"InvalidList": {
"Name": ["Elec_instrument"]
}
},
"Code": "",
"Success": true
}