Membuat beberapa NamaPerangkat kustom di bawah suatu Produk. Platform IoT memeriksa validitas NamaPerangkat tersebut.
Catatan penggunaan
Anda harus menggunakan operasi ini bersama dengan operasi BatchRegisterDeviceWithApplyId untuk mendaftarkan beberapa perangkat yang memiliki nama unik di bawah suatu Produk.
Prosedur:
1. Panggil operasi BatchCheckDeviceNames untuk menentukan nama perangkat yang ingin Anda daftarkan. Platform IoT mengembalikan ID aplikasi yang ditunjukkan oleh parameter ApplyId. Jika pemanggilan berhasil, permintaan verifikasi NamaPerangkat dikirimkan. Verifikasi aktual dilakukan secara asinkron.
2. Panggil operasi QueryBatchRegisterDeviceStatus untuk menanyakan hasil pengaturan nama.
3. Panggil operasi BatchRegisterDeviceWithApplyId untuk mendaftarkan perangkat.
4. Opsional. Panggil operasi QueryBatchRegisterDeviceStatus untuk menanyakan hasil pendaftaran perangkat.
5. Panggil operasi QueryPageByApplyId untuk melihat detail perangkat yang didaftarkan secara bersamaan.
Batasan
Anda dapat menentukan hingga 10.000 NamaPerangkat dalam satu pemanggilan.
Batas QPS
Anda dapat memanggil operasi API ini hingga 10 kali per detik per akun.
Pengguna RAM dari suatu Akun Alibaba Cloud berbagi kuota akun tersebut.
Debugging
Parameter permintaan
Parameter | Jenis | Wajib | Contoh | Deskripsi |
Action | String | Ya | BatchCheckDeviceNames | Operasi yang ingin Anda lakukan. Tetapkan nilainya ke BatchCheckDeviceNames. |
ProductKey | String | Ya | a1BwAGV**** | ProductKey dari Produk tempat perangkat tersebut berada. |
IotInstanceId | String | Tidak | iot-cn-0pp1n8t**** | ID instans IoT. Anda dapat melihat ID instans pada halaman Overview di Konsol Platform IoT. Penting
Untuk informasi selengkapnya, lihat topik Overview mengenai instans IoT. |
DeviceName.N | RepeatList | Tidak | light | Nama perangkat. NamaPerangkat harus unik dalam lingkup Produk. NamaPerangkat harus terdiri dari 4 hingga 32 karakter dan dapat berisi huruf, angka, tanda hubung (-), garis bawah (_), tanda at (@), titik (.), dan titik dua (:). Anda harus menentukan parameter ini atau parameter DeviceNameList.N.DeviceName. Jika Anda menentukan parameter ini dan parameter DeviceNameList.N.DeviceName secara bersamaan, nilai parameter DeviceNameList.N.DeviceName diutamakan. Catatan Anda dapat menentukan hingga 10.000 NamaPerangkat dalam satu pemanggilan. Jika jumlah NamaPerangkat melebihi batas, NamaPerangkat yang berlebih akan dibuang. |
DeviceNameList.N.DeviceName | String | Tidak | light1 | Nama perangkat. NamaPerangkat harus unik dalam lingkup Produk. NamaPerangkat harus terdiri dari 4 hingga 32 karakter dan dapat berisi huruf, angka, tanda hubung (-), garis bawah (_), tanda at (@), titik (.), dan titik dua (:). Anda harus menentukan parameter ini atau parameter DeviceName.N. Jika Anda menentukan parameter ini dan parameter DeviceName.N secara bersamaan, nilai parameter ini diutamakan. Catatan Anda dapat menentukan hingga 10.000 NamaPerangkat dalam satu pemanggilan. Jika jumlah NamaPerangkat melebihi batas, NamaPerangkat yang berlebih akan dibuang. |
DeviceNameList.N.DeviceNickname | String | Tidak | Smart light 1 | Alias perangkat. Alias harus terdiri dari 4 hingga 64 karakter dan dapat berisi huruf, angka, dan garis bawah (_). Penting Jika Anda menentukan parameter ini, Anda harus menentukan parameter DeviceNameList.N.DeviceName. |
Selain parameter permintaan spesifik operasi di atas, Anda harus menentukan parameter permintaan umum saat memanggil operasi ini. Untuk informasi selengkapnya tentang parameter permintaan umum, lihat Parameter Umum.
Parameter respons
Parameter | Tipe | Contoh | Deskripsi |
Code | String | iot.system.SystemException | Kode kesalahan yang dikembalikan jika pemanggilan gagal. Untuk informasi selengkapnya, lihat Kode kesalahan. |
Data | Struct | Data yang dikembalikan jika pemanggilan berhasil. | |
ApplyId | Long | 1295006 | ID aplikasi (ApplyId) yang dikembalikan jika pemanggilan berhasil. Saat Anda memanggil operasi BatchRegisterDeviceWithApplyId untuk mendaftarkan perangkat, Anda harus menentukan parameter ApplyId. |
InvalidDetailList | Array of InvalidDetailList | Detail NamaPerangkat tidak valid dari perangkat yang gagal didaftarkan. | |
InvalidDetailList | |||
DeviceName | String | light | NamaPerangkat. |
ErrorMsg | String | The device name is illegal. | Pesan kesalahan yang dikembalikan saat perangkat gagal didaftarkan. Catatan Pesan kesalahan ganda dipisahkan oleh tanda pipa vertikal (|). |
NickName | String | Smart Light 1 | Alias perangkat. |
InvalidDeviceNameList | List | { "InvalidDeviceName": [ "APT$", "aw" ] } | NamaPerangkat tidak valid yang gagal didaftarkan. |
InvalidDeviceNicknameList | List | { "InvalidDeviceNickname": [ "APT$", "aw" ] } | Alias perangkat tidak valid yang gagal didaftarkan. |
RepeatedDeviceNameList | List | { "RepeatedDeviceName": [ "APT$", "aw" ] } | NamaPerangkat duplikat yang gagal didaftarkan. |
ErrorMessage | String | A system exception occurred. | Pesan kesalahan yang dikembalikan jika pemanggilan gagal. |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | ID permintaan. |
Success | Boolean | true | Menunjukkan apakah permintaan berhasil. Nilai yang valid:
|
Contoh
Contoh permintaan
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=Smart light 3
&<Common request parameters>Contoh respons sukses
XML format
<BatchCheckDeviceNamesResponse>
<Data>
<ApplyId>1234567</ApplyId>
</Data>
<RequestId>E976E36B-6874-4FA4-8BC0-55F9BEC5E2EF</RequestId>
<Success>true</Success>
</BatchCheckDeviceNamesResponse>JSON format
{
"Data": {
"ApplyId": 1234567
},
"RequestId": "E976E36B-6874-4FA4-8BC0-55F9BEC5E2EF",
"Success": true
}Kode kesalahan
Untuk daftar kode kesalahan, lihat Kode Kesalahan Layanan.