Tag Perangkat - IoT Platform

Informasi tertentu tentang perangkat, seperti vendor dan model perangkat, dapat dilaporkan ke IoT Platform sebagai tag perangkat. Anda juga dapat menanyakan dan menghapus tag dari sebuah perangkat. Bagian ini menjelaskan topik-topik dan format data yang digunakan untuk mengirimkan, menanyakan, dan menghapus tag perangkat.

Kirim Tag

Topik berikut digunakan ketika perangkat mengirimkan permintaan ke IoT Platform dan IoT Platform memberikan respons kepada perangkat:

Topik Permintaan: /sys/${productKey}/${deviceName}/thing/deviceinfo/update
Topik Respons: /sys/${productKey}/${deviceName}/thing/deviceinfo/update_reply

Contoh permintaan dalam format JSON Alink:

{
    "id": "123",
    "version": "1.0",
    "sys":{
        "ack":0
    },
    "params":[
        {
            "attrKey": "Temperature",
            "attrValue": "36.8"
        }
    ],
    "method": "thing.deviceinfo.update"
}

Contoh respons dalam format JSON Alink:

{
    "id": "123",
    "code": 200,
    "data": {}
}

Parameter

Parameter	Tipe	Deskripsi
id	String	ID pesan. Nilai valid: 0 hingga 4294967295. Setiap ID pesan harus unik untuk perangkat.
version	String	Nomor versi protokol. Tetapkan nilai menjadi 1.0.
sys	Object	Parameter untuk fitur tambahan. Nilainya berisi bidang-bidang untuk setiap fitur. Catatan Jika tidak ada fitur tambahan yang dikonfigurasikan saat menggunakan SDK perangkat untuk mengembangkan fitur perangkat, parameter ini tidak tersedia. Fitur tambahan menggunakan konfigurasi default.
ack	Integer	Bidang fitur tambahan dalam parameter sys. Bidang ini menentukan apakah IoT Platform mengembalikan data respons untuk permintaan pendaftaran. Nilai valid: 1: IoT Platform mengembalikan data respons. 0: IoT Platform tidak mengembalikan data respons. Penting Untuk informasi lebih lanjut tentang parameter, lihat Contoh penggunaan model TSL. Jika fitur tidak dikonfigurasikan, parameter ini tidak tersedia. Secara default, IoT Platform mengembalikan data respons untuk permintaan pendaftaran.
params	Object	Parameter permintaan. Parameter attrKey menentukan kunci tag, dan parameter attrValue menentukan nilai tag. Parameter params dapat berisi hingga 200 elemen dalam array.
method	String	Metode permintaan. Tetapkan nilai menjadi `thing.deviceinfo.update`.
attrKey	String	Kunci tag. Kunci harus memiliki panjang 1 hingga 30 karakter, dan dapat berisi huruf, angka, garis bawah (_), tanda hubung (-), tanda pagar (#), tanda at (@), tanda persen (%), tanda ampersand (&), tanda bintang (*), dan titik (.).
attrValue	String	Nilai tag. Nilai harus memiliki panjang 1 hingga 128 karakter, dan dapat berisi karakter Cina, huruf, angka, karakter Jepang, garis bawah (_), tanda hubung (-), tanda pagar (#), tanda at (@), tanda persen (%), tanda ampersand (&), titik dua (:), dan titik (.). Setiap karakter Cina atau Jepang menggunakan dua karakter.
code	Integer	Kode status HTTP dalam respons. Nilai 200 menunjukkan bahwa permintaan berhasil.

Kode Kesalahan

Kode Kesalahan	Pesan Kesalahan	Deskripsi
460	kesalahan parameter permintaan	Pesan kesalahan yang dikembalikan karena parameter permintaan tidak valid.
6100	perangkat tidak ditemukan	Pesan kesalahan yang dikembalikan karena perangkat tidak ada.

Menanyakan Tag

Penting

Anda dapat menanyakan hingga 10 tag sekaligus.
Hanya tag kustom yang dapat ditanyakan. Tag internal IoT Platform tidak dapat ditanyakan.
Anda harus menentukan kunci tag yang ingin ditanyakan. Jika tidak, tidak ada data yang akan dikembalikan.

Topik berikut digunakan ketika perangkat mengirimkan permintaan ke IoT Platform dan IoT Platform memberikan respons kepada perangkat:

Topik Permintaan: /sys/${productKey}/${deviceName}/thing/deviceinfo/get
Topik Respons: /sys/${productKey}/${deviceName}/thing/deviceinfo/get_reply

Contoh permintaan dalam format JSON Alink:

{
    "id": "123",
    "version": "1.0",
    "params":{ 
        "attrKeys":["attrKey1", "attrKey2", "attrKey3"]
    },
    "method": "thing.deviceinfo.get"
}

Contoh respons dalam format JSON Alink:

{
    "id": "123",
    "code": 200,
    "data": [
        {
            "attrKey1":"v1"
        },
        {
            "attrKey2":"v2"
        },
        {
            "attrKey3":"v3"
        }
    ]
}

Parameter

Parameter	Tipe	Deskripsi
id	String	ID pesan. Nilai valid: 0 hingga 4294967295. Setiap ID pesan harus unik untuk perangkat.
version	String	Nomor versi protokol. Tetapkan nilai menjadi 1.0.
params	Object	Parameter permintaan. Parameter attrKeys menentukan kunci tag yang ingin Anda tanyakan.
attrKeys	JSONArray	Kunci tag yang ingin Anda tanyakan. Catatan Jika kunci tag tidak valid, seperti kunci tag duplikat, pengecualian akan dikembalikan. Jika kunci tag tidak ada, tidak ada data yang akan dikembalikan. Untuk informasi lebih lanjut tentang cara menentukan tag dalam format key-value untuk perangkat, lihat Tambahkan tag perangkat.
method	String	Metode permintaan. Tetapkan nilai menjadi `thing.deviceinfo.get`.
data	JSONArray	Informasi yang dikembalikan tentang tag, termasuk kunci dan nilai tag.
code	Integer	Kode status HTTP dalam respons. Nilai 200 menunjukkan bahwa permintaan berhasil.

Tabel berikut menjelaskan kode kesalahan.

Kode Kesalahan	Pesan Kesalahan	Deskripsi
460	kesalahan parameter permintaan	Pesan kesalahan yang dikembalikan karena parameter permintaan tidak valid. Sebagai contoh, nilai parameter attrKeys bukan array JSON, tidak ada kunci tag yang ditentukan, kunci tag yang ditentukan adalah duplikat, atau jumlah kunci tag yang ditentukan melebihi 10.
429	terlalu banyak permintaan	Pesan kesalahan yang dikembalikan karena pembatasan dipicu karena jumlah permintaan per detik (QPS) yang terlalu besar. Anda dapat memanggil operasi API ini hingga 50 kali per detik per akun. Catatan Pengguna RAM dari akun Alibaba Cloud berbagi kuota akun tersebut.

Hapus Tag

Topik berikut digunakan ketika perangkat mengirimkan permintaan ke IoT Platform dan IoT Platform memberikan respons kepada perangkat:

Topik Permintaan: /sys/${productKey}/${deviceName}/thing/deviceinfo/delete
Topik Respons: /sys/${productKey}/${deviceName}/thing/deviceinfo/delete_reply

Contoh permintaan dalam format JSON Alink:

{
    "id": "123",
    "version": "1.0",
    "sys":{
        "ack":0
    },
    "params": [
        {
            "attrKey": "Temperature"
        }
    ],
    "method": "thing.deviceinfo.delete"
}

Contoh respons dalam format JSON Alink:

{
    "id": "123",
    "code": 200,
    "data": {}
}

Parameter

Parameter	Tipe	Deskripsi
id	String	ID pesan. Nilai valid: 0 hingga 4294967295. Setiap ID pesan harus unik untuk perangkat.
version	String	Nomor versi protokol. Tetapkan nilai menjadi 1.0.
sys	Object	Parameter untuk fitur tambahan. Nilainya berisi bidang-bidang untuk setiap fitur. Catatan Jika tidak ada fitur tambahan yang dikonfigurasikan saat menggunakan SDK perangkat untuk mengembangkan fitur perangkat, parameter ini tidak tersedia. Fitur tambahan menggunakan konfigurasi default.
ack	Integer	Bidang fitur tambahan dalam parameter sys. Bidang ini menentukan apakah IoT Platform mengembalikan data respons untuk permintaan pendaftaran. Nilai valid: 1: IoT Platform mengembalikan data respons. 0: IoT Platform tidak mengembalikan data respons. Penting Untuk informasi lebih lanjut tentang parameter, lihat Contoh penggunaan model TSL. Jika fitur tidak dikonfigurasikan, parameter ini tidak tersedia. Secara default, IoT Platform mengembalikan data respons untuk permintaan pendaftaran.
params	Object	Parameter permintaan. Parameter attrKey menentukan kunci tag yang ingin Anda hapus.
method	String	Metode permintaan. Tetapkan nilai menjadi `thing.deviceinfo.delete`.
attrKey	String	Kunci tag yang ingin Anda hapus.
code	Integer	Kode status HTTP dalam respons. Nilai 200 menunjukkan bahwa permintaan berhasil.

Kode Kesalahan

Kode Kesalahan	Pesan Kesalahan	Deskripsi
460	kesalahan parameter permintaan	Pesan kesalahan yang dikembalikan karena parameter permintaan tidak valid.
6100	perangkat tidak ditemukan	Pesan kesalahan yang dikembalikan karena perangkat tidak ada.