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

说明

目前,仅华东2(cn-shanghai)地域支持设备X.509证书,如果地域不是华东2(cn-shanghai),则不能生成X.509证书,返回错误码iot.device.RegionNotSupportX509

请求参数

名称 类型 是否必须 描述
Action String 要执行的操作,取值:QueryBatchRegisterDeviceStatus
ProductKey String 要查询的设备所隶属的产品Key。
ApplyId Long 要查询的申请批次ID。申请批次ID在成功调用BatchRegisterDeviceWithApplyIdBatchRegisterDevice接口的返回结果中。
IotInstanceId String 公共实例不传此参数;仅独享实例需传入实例ID。
公共请求参数 - 请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 表示是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码
Data Data 调用成功时,返回的状态信息。详情参见下表DeviceApplyStatusInfo。
表 1. DeviceApplyStatusInfo
名称 类型 描述
Status String

申请单的处理状态和结果,取值:

  • CHECK:正在校验设备名称。
  • CHECK_SUCCESS:申请单中的所有设备名称校验成功。
  • CHECK_FAILED:申请单中有设备名称校验失败。
  • CREATE:正在创建设备。
  • CREATE_SUCCESS:申请单中的所有设备创建成功。
    说明 当设备所属产品的认证类型是X.509证书时,表示所有设备和对应的X.509证书都创建成功。
  • CREATE_FAILED:申请单中有设备创建失败。
    说明 当设备所属产品的认证类型是X.509时,只要当前批次中,任意一个设备或X.509证书创建失败,则返回创建失败。
ValidList List
  • 当返回Status参数值为CHECK_FAILEDCREATE_FAILED时,返回创建成功的设备名称集合。
  • 当返回Status参数值为CHECK_SUCCESSCREATE_SUCCESS时,该参数为空数组。
InvalidList List
  • 当返回Status参数值为CHECK_FAILEDCREATE_FAILED时,返回创建失败的设备名称集合。
  • 当返回Status参数值为CHECK_SUCCESSCREATE_SUCCESS时,该参数为空数组。

示例

请求示例

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

返回示例

  • JSON格式

    {
      "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
      "Success": true,
      "Data": {
        "Status": "CREATE_SUCCESS",
        "ValidList": {
          "Name": [
    
          ]
        },
        "InvalidList": {
          "Name": [
    
          ]
        }
      }
    }
  • XML格式

    <?xml version='1.0' encoding='utf-8'?>
    <QueryBatchCheckDeviceNamesStatusResponse>
        <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
        <Success>true</Success>
        <Data>
            <Status>CREATE_SUCCESS</Status>
            <ValidList/>
            <InvalidList/>
        </Data>
    </QueryBatchCheckDeviceNamesStatusResponse>