上传待批量注册的设备名称列表-阿里云帮助中心

使用说明

调用本接口注册自定义名称的设备。完成流程如下：

1. 调用本接口上传自定义的设备名称，接口会返回申请批次ID（BatchId）。

2. 调用接口QueryBatchStatus，根据申请批次ID查看设备名称校验状态。

3. 调用接口GenerateDeviceByBatchId，根据申请批次ID注册设备。

4. 调用接口QueryBatchStatus，根据申请批ID查看设备名称注册状态。

5. 调用接口QueryGenerateDevicesInfoList，查看批量注册的设备信息。或者调用QueryDevicesDownloadUrl，查询批量注册设备信息的转储OSS文件地址。

您也可调用接口GenerateDevice直接批量注册设备，系统自动生成设备名称。

QPS限制

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

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	UploadDeviceNameList	系统规定参数。取值：UploadDeviceNameList。
ProjectId	String	是	a123qs*****sy4QU	项目ID。
ProductKey	String	是	a3W*****	设备所属产品的ProductKey。
DeviceNames.N	RepeatList	是	light	设备名称列表。设备名称长度为4~32个字符，可以包含英文字母、数字和特殊字符：短划线（-）、下划线（_）、at（@）、半角句号（.）、半角冒号（:）。说明单次调用本接口，最多可传入10,000个设备名称。

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

返回数据

名称	类型	示例值	描述
Code	String	403	调用结果状态码：调用成功，返回200。调用失败，返回错误码。详细信息，请参见下文错误码。
Data	Struct		调用成功，返回的结果。
BatchId	String	1508******195	上传设备名称成功时，返回的申请批次ID。
InvalidDetailList	Array of invalidDetail		不合法设备名称列表的详细信息。
DeviceName	String	light-&01	设备名称。
ErrorMsg	String	The device name is illegal.	上传设备名称失败时，返回的出错信息。
InvalidDeviceNameList	List	["device-ui&", "s2-*2s"]	不合法设备名称列表。
RepeatedDeviceNameList	List	["device01", "device02"]	重复设备名称列表。
ErrorMessage	String	Request auth failed.	调用失败时，返回的出错信息。
RequestId	String	E5****-4-B-8E-D3********65	阿里云为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 true：调用成功。 false：调用失败。

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=UploadDeviceNameList
&ProjectId=a123qs*****sy4QU
&ProductKey=a3W*****
&DeviceNames.1=light
&<公共请求参数>

正常返回示例

XML格式

<UploadDeviceNameListResponse>
  <RequestId>E5******-4***-***B-8**E-D3********65</RequestId>
  <Data>
        <BatchId>1508******195</BatchId>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</UploadDeviceNameListResponse>

JSON格式

{
    "RequestId": "E5******-4***-***B-8**E-D3********65",
    "Data": {
        "BatchId": "1508******195"
    },
    "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.	未知内部错误。
400	iot.vision.ActiveCodeInsufficient	Active code quota is insufficient.	可用激活码不足。
400	iot.vision.DevicesCountExceedLimit	The devices count exceed the limit.	创建设备数量超过限制。
400	iot.vision.DevicesExceedUnreleasedProductLimit	Devices count exceed the limit of unreleased product.	创建设备数量超过未发布产品的试产设备数量。

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