RegisterDevice - IoT Platform - Alibaba Cloud Documentation Center

Mendaftarkan perangkat di bawah suatu Produk.

Catatan Penggunaan

Jika Anda memanggil operasi ini untuk mendaftarkan perangkat di bawah suatu Produk, perangkat tersebut akan ditambahkan ke dalam Produk di Konsol IoT Platform. Setelah terdaftar, IoT Platform mengeluarkan parameter IotId untuk perangkat tersebut. Parameter ini merupakan identifier unik global (GUID) dari perangkat. Untuk melakukan operasi pada perangkat, Anda harus menggunakan parameter IotId sebagai identifikatornya.

Anda juga dapat mengidentifikasi perangkat menggunakan kombinasi parameter ProductKey dan DeviceName. ProductKey dikeluarkan oleh IoT Platform untuk suatu Produk saat Anda membuat Produk tersebut, sedangkan DeviceName ditentukan atau dihasilkan secara acak saat Anda membuat perangkat. Parameter IotId memiliki prioritas lebih tinggi dibandingkan kombinasi ProductKey dan DeviceName.

Untuk informasi tentang cara mendaftarkan beberapa perangkat di bawah satu Produk sekaligus, lihat BatchRegisterDeviceWithApplyId.

Batasan

Setiap Akun Alibaba Cloud dapat menjalankan maksimal 30 permintaan per detik (QPS).

Catatan Pengguna RAM dari suatu Akun Alibaba Cloud berbagi kuota akun tersebut.

Debugging

Alibaba Cloud menyediakan OpenAPI Explorer untuk menyederhanakan penggunaan API. OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi ini untuk berbagai SDK.

Parameter Permintaan

Parameter	Tipe	Wajib	Contoh	Deskripsi
Action	String	Ya	RegisterDevice	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke RegisterDevice.
ProductKey	String	Ya	a1BwAGV****	ProductKey dari Produk tempat perangkat tersebut berada. ProductKey adalah GUID yang dikeluarkan oleh IoT Platform untuk suatu Produk. Anda dapat menggunakan Konsol IoT Platform atau memanggil operasi QueryProductList untuk melihat informasi semua Produk dalam akun saat ini.
IotInstanceId	String	Tidak	iot_instc_pu***_c-v64********	ID instans. Anda dapat melihat ID instans pada halaman Overview di Konsol IoT Platform. Penting Jika instans Anda memiliki ID, Anda wajib mengonfigurasi parameter ini. Jika tidak menyetel parameter ini, pemanggilan akan gagal. Jika instans Anda tidak memiliki halaman Overview atau ID, Anda tidak perlu menyetel parameter ini. Untuk informasi selengkapnya, lihat Overview.
DeviceName	String	Tidak	light	DeviceName perangkat. Nama harus terdiri dari 4 hingga 32 karakter, dan dapat berisi huruf, angka, tanda hubung (-), garis bawah (_), tanda at (@), titik (.), dan titik dua (:). Anda dapat menggunakan kombinasi parameter DeviceName dan ProductKey untuk mengidentifikasi perangkat. Catatan Jika Anda tidak menentukan parameter ini, IoT Platform akan menghasilkan DeviceName secara acak.
DevEui	String	Tidak	e8SDdgeIlk3nED****	DevEUI perangkat LoRaWAN. Parameter ini wajib diisi saat Anda membuat perangkat LoRaWAN.
Nickname	String	Tidak	Campus light	Alias perangkat. Alias harus terdiri dari 4 hingga 64 karakter, dan dapat berisi huruf, angka, dan garis bawah (_). Catatan Jika Anda tidak menentukan parameter ini, IoT Platform tidak akan menghasilkan alias untuk perangkat tersebut.
PinCode	String	Tidak	DIe80dfeg*****	Kode PIN perangkat LoRaWAN. Parameter ini digunakan untuk memverifikasi DevEUI. Saat membuat perangkat LoRaWAN, tetapkan LoraNodeType ke ALIYUNDEFINED. Parameter ini wajib diisi.
JoinEui	String	Tidak	Ede4tde8erth****	JoinEUI perangkat LoRaWAN. Saat membuat perangkat LoRaWAN, tetapkan LoraNodeType ke USERDEFINED. Parameter ini wajib diisi.
AppKey	String	Tidak	674f***	AppKey perangkat LoRaWAN. Saat membuat perangkat LoRaWAN, tetapkan LoraNodeType ke USERDEFINED. Parameter ini wajib diisi.
LoraNodeType	String	Tidak	ALIYUNDEFINED	Tipe perangkat LoRaWAN. Nilai yang valid: ALIYUNDEFINED: Perangkat dikeluarkan oleh Alibaba Cloud. Anda harus menentukan DevEui dan PinCode. USERDEFINED: Perangkat ditentukan pengguna. Anda harus menentukan DevEui, JoinEui, dan AppKey.

Selain parameter permintaan khusus operasi di atas, Anda harus menentukan parameter permintaan umum saat memanggil operasi ini. Untuk informasi selengkapnya, lihat Parameter permintaan umum.

Parameter Tanggapan

Parameter	Tipe	Contoh	Deskripsi
Code	String	iot.system.SystemException	Kode kesalahan yang dikembalikan jika pemanggilan gagal. Untuk informasi selengkapnya, lihat Kode kesalahan.
Data	Struct		Informasi perangkat yang dikembalikan jika pemanggilan berhasil.
DevEui	String	e8SDdgeIlk3nED****	DevEUI perangkat LoRaWAN. Parameter ini hanya dikembalikan saat Anda membuat perangkat LoRaWAN.
DeviceName	String	light	DeviceName perangkat. Penting Jaga kerahasiaan informasi ini.
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	DeviceSecret perangkat. Penting Jaga kerahasiaan informasi ini.
IotId	String	1O4YPNtRqB2anumz2Canp4GB7q****	ID perangkat. ID ini adalah identifier unik yang dikeluarkan oleh IoT Platform untuk perangkat tersebut. Penting Jaga kerahasiaan informasi ini.
JoinEui	String	Ede4tde8erth****	JoinEUI perangkat LoRaWAN. Parameter ini hanya dikembalikan saat Anda membuat perangkat LoRaWAN.
Nickname	String	Campus light	Alias perangkat. Jika Anda tidak menentukan alias untuk perangkat, parameter ini akan kosong.
ProductKey	String	a1BwAGV****	ProductKey dari Produk tempat perangkat tersebut berada.
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 pemanggilan berhasil. true: Pemanggilan berhasil. false: Pemanggilan gagal.

Contoh

Contoh permintaan

https://iot.cn-shanghai.aliyuncs.com/?Action=RegisterDevice
&ProductKey=a1rYuVF****
&DeviceName=device1
&Nickname=detectors_in_beijing
&<Common request parameters>

Contoh tanggapan sukses

XML format

<RegisterDeviceResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
  <Data>
        <DeviceName>device1</DeviceName>
        <ProductKey>a1rYuVF****</ProductKey>
        <DeviceSecret>tXHf4ezGEHcwdyMwoCDHGBmk9avi****</DeviceSecret>
        <IotId>CqXL5h5ysRTA4NxjABjj0010fa****</IotId>
        <Nickname>detectors_in_beijing</Nickname>
  </Data>
</RegisterDeviceResponse>

JSON format

{
    "RequestId": "57b144cf-09fc-4916-a272-a62902d5b207", 
    "Success": true, 
    "Data": {
        "DeviceName": "device1", 
        "ProductKey": "a1rYuVF****", 
        "DeviceSecret": "tXHf4ezGEHcwdyMwoCDHGBmk9avi****", 
        "IotId": "CqXL5h5ysRTA4NxjABjj0010fa****", 
        "Nickname": "detectors_in_beijing"
    }
}

Kode Kesalahan

Untuk daftar kode kesalahan, kunjungi API Error Center.