BatchCheckDeviceNames
調(diào)用該接口在指定產(chǎn)品下批量自定義設(shè)備名稱(chēng)。物聯(lián)網(wǎng)平臺(tái)會(huì)檢查名稱(chēng)的合法性。
使用說(shuō)明
批量注冊(cè)設(shè)備有兩種方式:
- 由系統(tǒng)隨機(jī)生成設(shè)備名稱(chēng):請(qǐng)調(diào)用BatchRegisterDevice接口。
-
自定義設(shè)備名稱(chēng):需本接口與BatchRegisterDeviceWithApplyId等接口結(jié)合實(shí)現(xiàn)。請(qǐng)按以下流程操作:
1. 調(diào)用本接口,傳入要批量注冊(cè)的設(shè)備的名稱(chēng)。物聯(lián)網(wǎng)平臺(tái)檢查您提交的設(shè)備名稱(chēng)符合要求后,返回申請(qǐng)批次ID(ApplyId)。ApplyId將用于設(shè)備名稱(chēng)校驗(yàn)結(jié)果查詢(xún)、批量設(shè)備注冊(cè)和設(shè)備信息查詢(xún)。
2. 調(diào)用QueryBatchRegisterDeviceStatus接口,根據(jù)申請(qǐng)批次ID,查看名稱(chēng)校驗(yàn)結(jié)果。請(qǐng)確保自定義設(shè)備名稱(chēng)全部校驗(yàn)通過(guò),再執(zhí)行后續(xù)操作完成設(shè)備注冊(cè)。
說(shuō)明 如果有校驗(yàn)失敗的設(shè)備名稱(chēng),請(qǐng)根據(jù)錯(cuò)誤信息提示進(jìn)行修正,然后重新調(diào)用BatchCheckDeviceNames接口獲取新的申請(qǐng)批次ID(ApplyId)后,再次調(diào)用QueryBatchRegisterDeviceStatus接口確認(rèn)全部設(shè)備名稱(chēng)校驗(yàn)通過(guò)。3. 調(diào)用BatchRegisterDeviceWithApplyId接口批量注冊(cè)設(shè)備。本接口調(diào)用返回的成功結(jié)果,僅表示批量注冊(cè)的申請(qǐng)已經(jīng)提交成功。實(shí)際的注冊(cè)會(huì)有一個(gè)過(guò)程。
4. (可選)調(diào)用QueryBatchRegisterDeviceStatus查看設(shè)備注冊(cè)結(jié)果。
5. 調(diào)用QueryPageByApplyId查看批量注冊(cè)的設(shè)備信息。
使用限制
單次調(diào)用本接口,最多能定義10,000 個(gè)設(shè)備名稱(chēng)。但對(duì)于使用X.509證書(shū)認(rèn)證的設(shè)備,最多只能定義1,000個(gè)設(shè)備名稱(chēng)。
QPS限制
單個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)(QPS)最大限制為10。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求參數(shù)
名稱(chēng) |
類(lèi)型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | BatchCheckDeviceNames | 系統(tǒng)規(guī)定參數(shù)。取值:BatchCheckDeviceNames。 |
ProductKey | String | 是 | a1BwAGV**** | 要注冊(cè)的設(shè)備所屬的產(chǎn)品ProductKey。 |
IotInstanceId | String | 否 | iot-cn-0pp1n8t**** | 實(shí)例ID。您可在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)的實(shí)例概覽頁(yè)面,查看當(dāng)前實(shí)例的ID。 重要
實(shí)例的更多信息,請(qǐng)參見(jiàn)實(shí)例概述。 |
DeviceName.N | RepeatList | 否 | light | 要注冊(cè)的設(shè)備名稱(chēng)。設(shè)備名稱(chēng)在產(chǎn)品內(nèi)具有唯一性。支持英文字母、數(shù)字、短劃線(-)、下劃線(_)、at(@)、英文句點(diǎn)(.)和英文冒號(hào)(:),長(zhǎng)度限制為4~32個(gè)字符。 該參數(shù)與DeviceNameList.N.DeviceName必須傳入一種。若您同時(shí)傳入該參數(shù)與DeviceNameList.N.DeviceName,則以DeviceNameList.N.DeviceName為準(zhǔn)。 說(shuō)明 單次調(diào)用,最多能傳入10,000個(gè)設(shè)備名稱(chēng)。超過(guò)該限制的數(shù)據(jù)會(huì)被丟棄。 |
DeviceNameList.N.DeviceName | String | 否 | light1 | 要注冊(cè)的設(shè)備名稱(chēng)。設(shè)備名稱(chēng)在產(chǎn)品內(nèi)具有唯一性。支持英文字母、數(shù)字、短劃線(-)、下劃線(_)、at(@)、英文句點(diǎn)(.)和英文冒號(hào)(:),長(zhǎng)度限制為4~32個(gè)字符。 該參數(shù)與DeviceName.N必須傳入一種。若您同時(shí)傳入該參數(shù)與DeviceName.N,則以該參數(shù)為準(zhǔn)。 說(shuō)明 單次調(diào)用,最多能傳入10,000個(gè)設(shè)備名稱(chēng)。超過(guò)該限制的數(shù)據(jù)會(huì)被丟棄。 |
DeviceNameList.N.DeviceNickname | String | 否 | 智能燈1 | 要注冊(cè)的設(shè)備的備注名稱(chēng)。支持中文、英文字母、日文、數(shù)字和下劃線(_),備注名稱(chēng)長(zhǎng)度為4~64個(gè)字符,一個(gè)中文或日文占2個(gè)字符。 重要 若傳入該參數(shù),則必須同時(shí)傳入DeviceNameList.N.DeviceName。
|
調(diào)用API時(shí),除了本文介紹的該API的特有請(qǐng)求參數(shù),還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說(shuō)明,請(qǐng)參見(jiàn)公共參數(shù)文檔。
返回?cái)?shù)據(jù)
名稱(chēng) |
類(lèi)型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 調(diào)用失敗時(shí),返回的錯(cuò)誤碼。更多信息,請(qǐng)參見(jiàn)錯(cuò)誤碼。 |
Data | Struct | 返回的數(shù)據(jù)。 |
|
ApplyId | Long | 1295006 | 調(diào)用成功時(shí),系統(tǒng)返回的申請(qǐng)批次ID。使用該ApplyId,調(diào)用BatchRegisterDeviceWithApplyId接口來(lái)批量創(chuàng)建設(shè)備。 |
InvalidDetailList | Array of InvalidDetailList | 注冊(cè)設(shè)備名稱(chēng)失敗時(shí),不合法設(shè)備名稱(chēng)列表的詳細(xì)信息。 |
|
InvalidDetailList | |||
DeviceName | String | light | 設(shè)備名稱(chēng)。 |
ErrorMsg | String | The device name is illegal. | 注冊(cè)設(shè)備名稱(chēng)失敗時(shí),返回的出錯(cuò)信息。 說(shuō)明 多個(gè)出錯(cuò)信息間使用豎線(|)隔開(kāi)。 |
NickName | String | 智能燈-1 | 設(shè)備的備注名稱(chēng)。 |
InvalidDeviceNameList | List | { "InvalidDeviceName": [ "APT$", "aw" ] } | 注冊(cè)設(shè)備名稱(chēng)失敗時(shí),返回的不合法設(shè)備名稱(chēng)列表。 |
InvalidDeviceNicknameList | List | { "InvalidDeviceNickname": [ "APT$", "aw" ] } | 注冊(cè)設(shè)備名稱(chēng)失敗時(shí),返回的不合法設(shè)備備注名稱(chēng)列表。 |
RepeatedDeviceNameList | List | { "RepeatedDeviceName": [ "APT$", "aw" ] } | 注冊(cè)設(shè)備名稱(chēng)失敗時(shí),返回的重復(fù)設(shè)備名稱(chēng)列表。 |
ErrorMessage | String | 系統(tǒng)異常 | 調(diào)用失敗時(shí),返回的出錯(cuò)信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。 |
Success | Boolean | true | 是否調(diào)用成功。
|
示例
請(qǐng)求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=BatchCheckDeviceNames
&productKey=a1BwAGV****
&DeviceNameList.1.DeviceName=light1
&DeviceNameList.2.DeviceName=light2
&DeviceNameList.3.DeviceName=light3
&DeviceNameList.3.DeviceNickname=智能燈3
&<公共請(qǐng)求參數(shù)>
正常返回示例
XML
格式
<BatchCheckDeviceNamesResponse>
<Data>
<ApplyId>1234567</ApplyId>
</Data>
<RequestId>E976E36B-6874-4FA4-8BC0-55F9BEC5E2EF</RequestId>
<Success>true</Success>
</BatchCheckDeviceNamesResponse>
JSON
格式
{
"Data": {
"ApplyId": 1234567
},
"RequestId": "E976E36B-6874-4FA4-8BC0-55F9BEC5E2EF",
"Success": true
}