Topik protokol Alink dan format JSON untuk konfigurasi remote - IoT Platform

Topik ini menjelaskan topik dan format JSON Alink yang digunakan dalam skenario berikut: Perangkat meminta informasi konfigurasi dari IoT Platform, serta IoT Platform mendorong informasi konfigurasi ke perangkat.

Untuk informasi lebih lanjut tentang cara menggunakan fitur konfigurasi jarak jauh, lihat Konfigurasi Jarak Jauh di panduan pengguna.

Perangkat Meminta Informasi Konfigurasi dari IoT Platform

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

Topik permintaan: /sys/${productKey}/${deviceName}/thing/config/get
Topik respons: /sys/${productKey}/${deviceName}/thing/config/get_reply

Contoh permintaan dalam format JSON Alink:

{
  "id": 123,
  "version": "1.0",
  "sys":{
      "ack":0
  },
  "params": {
    "configScope": "product",
    "getType": "file"
  },
  "method": "thing.config.get"
}

Contoh respons dalam format JSON Alink:

{
  "id": "123",
  "version": "1.0",
  "code": 200,
  "data": {
    "configId": "123dagdah",
    "configSize": 1.234.565,
    "sign": "123214adfadgadg",
    "signMethod": "Sha256",
    "url": "https://iotx-config.oss-cn-shanghai.aliyuncs.com/nopoll_0.4.4.tar.gz?Expires=1502955804&OSSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&Signature=XfgJu7P6DWWejstKJgXJEH0qAKU%3D&security-token=CAISuQJ1q6Ft5B2yfSjIpK6MGsyN1Jx5jo6mVnfBglIPTvlvt5D50Tz2IHtIf3NpAusdsv03nWxT7v4flqFyTINVAEvYZJOPKGrGR0DzDbDasumZsJbo4f%2FMQBqEaXPS2MvVfJ%2BzLrf0ceusbFbpjzJ6xaCAGxypQ12iN%2B%2Fr6%2F5gdc9FcQSkL0B8ZrFsKxBltdUROFbIKP%2BpKWSKuGfLC1dysQcO1wEP4K%2BkkMqH8Uic3h%2Boy%2BgJt8H2PpHhd9NhXuV2WMzn2%2FdtJOiTknxR7ARasaBqhelc4zqA%2FPPlWgAKvkXba7aIoo01fV4jN5JXQfAU8KLO8tRjofHWmojNzBJAAPpYSSy3Rvr7m5efQrrybY1lLO6iZy%2BVio2VSZDxshI5Z3McKARWct06MWV9ABA2TTXXOi40BOxuq%2B3JGoABXC54TOlo7%2F1wTLTsCUqzzeIiXVOK8CfNOkfTucMGHkeYeCdFkm%2FkADhXAnrnGf5a4FbmKMQph2cKsr8y8UfWLC6IzvJsClXTnbJBMeuWIqo5zIynS1pm7gf%2F9N3hVc6%2BEeIk0xfl2tycsUpbL2FoaGk6BAF8hWSWYUXsv59d5Uk%3D",
    "getType": "file"
  }
}

Tabel berikut menjelaskan parameter-parameter tersebut.

Parameter	Tipe	Deskripsi
id	String	ID pesan. Nilai valid: `0` hingga `4294967295`. Setiap ID pesan harus unik untuk perangkat.
version	String	Versi protokol. Nilai valid: `1.0`.
sys	Objek	Parameter untuk fitur ekstensi. Nilainya berisi bidang-bidang untuk setiap fitur. Catatan Jika tidak ada fitur ekstensi yang dikonfigurasikan saat Anda menggunakan SDK perangkat untuk mengembangkan fitur perangkat, parameter ini tidak tersedia. Fitur ekstensi menggunakan konfigurasi default.
ack	Integer	Bidang fitur ekstensi 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 ini, lihat Contoh Penggunaan Model TSL. Jika fitur ini tidak dikonfigurasikan, parameter ini tidak tersedia. Secara default, IoT Platform mengembalikan data respons untuk permintaan pendaftaran.
configScope	String	Ruang lingkup konfigurasi. IoT Platform hanya mendukung konfigurasi tingkat produk. Nilai valid: `product`.
getType	String	Format dalam mana konfigurasi dikembalikan. IoT Platform mendukung format file. Nilai valid: `file`.
method	String	Metode permintaan. Nilai valid: `thing.config.get`.
configId	String	ID file konfigurasi.
configSize	Long	Ukuran file konfigurasi, dalam byte.
sign	String	Tanda tangan.
signMethod	String	Metode penandatanganan. IoT Platform hanya mendukung SHA-256.
url	String	URL file konfigurasi yang disimpan di Object Storage Service (OSS).
code	Integer	Kode status HTTP dalam respons. Jika 200 dikembalikan, permintaan berhasil. Jika kode status lain dikembalikan, permintaan gagal. Untuk informasi lebih lanjut, lihat Kode Umum pada Perangkat.

Tabel berikut menjelaskan kode-kode kesalahan.

Kode status HTTP	Pesan kesalahan	Deskripsi
6713	fungsi konfigurasi thing tidak tersedia	Pesan kesalahan yang dikembalikan karena fitur konfigurasi jarak jauh dinonaktifkan untuk produk tersebut. Untuk menyelesaikan masalah ini, lakukan langkah-langkah berikut: Masuk ke Konsol IoT Platform.Di panel navigasi kiri, pilih Maintenance > Remote Config. Kemudian, aktifkan fitur konfigurasi jarak jauh untuk produk tersebut.
6710	tidak ada data	Pesan kesalahan yang dikembalikan karena tidak ada data konfigurasi yang tersedia.

IoT Platform Mendorong Informasi Konfigurasi ke Perangkat

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

Topik permintaan: /sys/${productKey}/${deviceName}/thing/config/push
Topik respons: /sys/${productKey}/${deviceName}/thing/config/push_reply

Setelah Anda mengonfigurasi dorongan konfigurasi untuk beberapa perangkat di konsol IoT Platform, IoT Platform secara asinkron mendorong informasi konfigurasi ke perangkat-perangkat yang berlangganan topik dorongan konfigurasi.

Contoh permintaan dalam format JSON Alink:

{
  "id": "123",
  "version": "1.0",
  "params": {
    "configId": "123dagdah",
    "configSize": 1.234.565,
    "sign": "123214adfadgadg",
    "signMethod": "Sha256",
    "url": "https://iotx-config.oss-cn-shanghai.aliyuncs.com/nopoll_0.4.4.tar.gz?Expires=1502955804&OSSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&Signature=XfgJu7P6DWWejstKJgXJEH0qAKU%3D&security-token=CAISuQJ1q6Ft5B2yfSjIpK6MGsyN1Jx5jo6mVnfBglIPTvlvt5D50Tz2IHtIf3NpAusdsv03nWxT7v4flqFyTINVAEvYZJOPKGrGR0DzDbDasumZsJbo4f%2FMQBqEaXPS2MvVfJ%2BzLrf0ceusbFbpjzJ6xaCAGxypQ12iN%2B%2Fr6%2F5gdc9FcQSkL0B8ZrFsKxBltdUROFbIKP%2BpKWSKuGfLC1dysQcO1wEP4K%2BkkMqH8Uic3h%2Boy%2BgJt8H2PpHhd9NhXuV2WMzn2%2FdtJOiTknxR7ARasaBqhelc4zqA%2FPPlWgAKvkXba7aIoo01fV4jN5JXQfAU8KLO8tRjofHWmojNzBJAAPpYSSy3Rvr7m5efQrrybY1lLO6iZy%2BVio2VSZDxshI5Z3McKARWct06MWV9ABA2TTXXOi40BOxuq%2B3JGoABXC54TOlo7%2F1wTLTsCUqzzeIiXVOK8CfNOkfTucMGHkeYeCdFkm%2FkADhXAnrnGf5a4FbmKMQph2cKsr8y8UfWLC6IzvJsClXTnbJBMeuWIqo5zIynS1pm7gf%2F9N3hVc6%2BEeIk0xfl2tycsUpbL2FoaGk6BAF8hWSWYUXsv59d5Uk%3D",
    "getType": "file"
  },
  "method": "thing.config.push"
}

Contoh respons dalam format JSON Alink:

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

Tabel berikut menjelaskan parameter-parameter tersebut.

Parameter	Tipe	Deskripsi
id	String	ID pesan. Nilai valid: `0` hingga `4294967295`. Setiap ID pesan harus unik untuk perangkat.
version	String	Versi protokol. Nilai valid: `1.0`.
configScope	String	Ruang lingkup konfigurasi. IoT Platform hanya mendukung konfigurasi tingkat produk. Nilai valid: `product`.
getType	String	Format dalam mana konfigurasi dikembalikan. IoT Platform mendukung format file. Nilai valid: `file`.
configId	String	ID file konfigurasi.
configSize	Long	Ukuran file konfigurasi, dalam byte.
sign	String	Tanda tangan.
signMethod	String	Metode penandatanganan. IoT Platform hanya mendukung SHA-256.
url	String	URL file konfigurasi yang disimpan di OSS.
method	String	Metode permintaan. Nilai valid: `thing.config.push`.
code	Integer	Kode status HTTP dalam respons. Untuk informasi lebih lanjut, lihat Kode Umum pada Perangkat.

Anda dapat menggunakan mesin aturan IoT Platform untuk meneruskan respons dari perangkat ke topik lain atau layanan Alibaba Cloud lainnya. Untuk informasi lebih lanjut tentang cara menggunakan fitur penerusan data, lihat Konfigurasikan Aturan Penerusan Data. Untuk informasi lebih lanjut tentang topik respons perangkat dan format data, lihat bagian "Kirimkan respons ke permintaan downstream" dari topik Format Data.