文档

查看设备批次上传或创建任务的状态

更新时间:
一键部署

调用接口QueryBatchStatus查看设备批次上传任务和注册任务的状态。

QPS限制

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

说明 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String QueryBatchStatus

系统规定参数。取值:QueryBatchStatus。

ProjectId String a123qs*****sy4QU

项目ID。

ProductKey String a3W*****

设备所属产品的ProductKey

BatchId String 1508******195

申请的批次ID。

调用UploadDeviceNameListGenerateDevice接口,返回的申请批次ID(BatchId)。

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

返回数据

名称

类型

示例值

描述

Code String 400

调用结果状态码:

  • 调用成功,返回200。
  • 调用失败,返回错误码。详细信息,请参见下文错误码
Data Struct

调用成功,返回的结果。

InvalidDetailList Array of invalidDetail

不合法设备名称列表的详细信息。

DeviceName String light-01

设备名称。

ErrorMsg String The device name is illegal.

上传设备名称失败时,返回的出错信息。

InvalidList List ["device-&ui", "s2-*2s"]
  • 当返回Status参数值为CHECK_FAILEDCREATE_FAILED时,表示有设备校验或创建失败,该参数返回创建失败的设备名称集合。
  • 当返回Status参数值为CHECK_SUCCESSCREATE_SUCCESS时,表示所有设备校验或创建成功,无需返回设备列表,该参数为空数组。
Status String CHECK

批次状态。取值:

  • CHECK:正在校验设备名称。
  • CHECK_SUCCESS:申请单中的所有设备名称校验成功。
  • CHECK_FAILED:申请单中有设备名称校验失败。
  • CREATE:正在创建设备。
  • CREATE_SUCCESS:申请单中的所有设备创建成功。
  • CREATE_FAILED:申请单中有设备创建失败。
ValidList List ["device01", "device02"]
  • 当返回Status参数值为CHECK_FAILEDCREATE_FAILED时,表示有设备创建失败,该参数返回创建成功的设备名称集合。
  • 当返回Status参数值为CHECK_SUCCESSCREATE_SUCCESS时,表示所有设备创建成功,无需返回设备列表,该参数为空数组。
ErrorMessage String Unexpected internal error.

调用失败时,返回的出错信息。

RequestId String E5******-4***-***B-8**E-D3********65

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

Success Boolean true

是否调用成功。

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

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryBatchStatus
&ProjectId=a123qs*****sy4QU
&ProductKey=a3W*****
&BatchId=1508******195
&<公共请求参数>

正常返回示例

XML格式

<QueryBatchStatusResponse>
  <RequestId>E5******-4***-***B-8**E-D3********65</RequestId>
  <Data>
        <Status>CREATE_SUCCESS</Status>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</QueryBatchStatusResponse>

JSON格式

{
    "RequestId": "E5******-4***-***B-8**E-D3********65",
    "Data": {
        "Status": "CREATE_SUCCESS"
    },
    "Code": 200,
    "Success": true
}

错误码

HttpCode

错误码

错误信息

描述

400 iot.vision.RequestParamError Request parameter error. 请求参数错误。
403 iot.vision.RequestAuthFailed Request auth failed. 请求鉴权失败。
403 iot.vision.RequestForbidden Request forbidden. 请求被禁止。
429 iot.vision.RequestTrafficControl Request traffic control. 请求太频繁被限流。
400 iot.vision.UnexpectedInternalError Unexpected internal error. 未知内部错误。

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