调用该接口查询批量注册设备申请的处理状态和结果。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为30。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 QueryBatchRegisterDeviceStatus

系统规定参数。取值：QueryBatchRegisterDeviceStatus。
ApplyId Long 是 1295006

要查询的申请批次ID。申请批次ID在成功调用BatchRegisterDeviceWithApplyId或BatchRegisterDevice接口的返回结果中。
ProductKey String 是 a1BwAGV****

要查询的设备所属的产品ProductKey。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无实例概览页面或ID值，则无需传入。

实例的更多信息，请参见实例概述。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回的错误码。更多信息，请参见错误码。

说明 目前仅华东2（cn-shanghai）地域支持设备X.509证书，如果地域不是华东2（cn-shanghai），则不能生成X.509证书，返回错误码iot.device.RegionNotSupportX509。
Data Struct

调用成功时，返回的状态信息。
InvalidList List { "Name": ["Elec_instrument"] }
  • 当返回Status参数值为CHECK_FAILED或CREATE_FAILED时，表示有设备创建失败，该参数返回创建失败的设备名称集合。
  • 当返回Status参数值为CHECK_SUCCESS或CREATE_SUCCESS时，表示所有设备创建成功，无需返回设备列表，该参数为空数组。
Status String CREATE_SUCCESS

申请单的处理状态和结果，取值：

  • CHECK：正在校验设备名称。
  • CHECK_SUCCESS：申请单中的所有设备名称校验成功。
  • CHECK_FAILED：申请单中有设备名称校验失败。
  • CREATE：正在创建设备。
  • CREATE_SUCCESS：申请单中的所有设备创建成功。
    说明 当设备所属产品的认证类型是X.509证书时，表示所有设备和对应的X.509证书都创建成功。
  • CREATE_FAILED：申请单中有设备创建失败。
    说明 当设备所属产品的认证类型是X.509时，只要当前批次中，任意一个设备或X.509证书创建失败，则返回创建失败。
ValidList List { "Name": ["light3"] }
  • 当返回Status参数值为CHECK_FAILED或CREATE_FAILED时，表示有设备创建失败，该参数返回创建成功的设备名称集合。
  • 当返回Status参数值为CHECK_SUCCESS或CREATE_SUCCESS时，表示所有设备创建成功，无需返回设备列表，该参数为空数组。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。
Success Boolean true

表示是否调用成功。

  • true：调用成功。
  • false：调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryBatchRegisterDeviceStatus
&ProductKey=a1BwAGV****
&ApplyId=1234567
&<公共请求参数>

正常返回示例

XML格式

<QueryBatchCheckDeviceNamesStatusResponse>
  <RequestId>079CAED3-502B-5BBA-BA8A-B1A053021E43</RequestId>
  <Data>
        <Status>CHECK_FAILED</Status>
        <InvalidList>
              <Name>Elec_instrument</Name>
        </InvalidList>
        <ValidList>
              <Name>light3</Name>
        </ValidList>
  </Data>
  <Code></Code>
  <Success>true</Success>
</QueryBatchCheckDeviceNamesStatusResponse>

JSON格式

{
	"RequestId": "079CAED3-502B-5BBA-BA8A-B1A053021E43",
	"Data": {
		"Status": "CHECK_FAILED",
		"InvalidList": {
			"Name": [
				"Elec_instrument"
			]
		},
		"ValidList": {
			"Name": [
				"light3"
			]
		}
	},
	"Code": "",
	"Success": true
}

错误码

访问错误中心查看更多错误码。