PubBroadcast - IoT Platform - Alibaba Cloud Documentation Center

Menyiarkan pesan ke perangkat online dari suatu produk. Anda dapat menentukan semua perangkat online atau hanya perangkat online yang berlangganan topik tertentu.

Catatan penggunaan

Anda dapat mengatur TopicFullName dalam request untuk menentukan perangkat yang akan menerima siaran pesan. Untuk informasi selengkapnya, lihat deskripsi parameter TopicFullName dalam topik ini.

Batas QPS

Anda dapat memanggil operasi ini hingga 1 kali per detik per akun untuk menyiarkan pesan ke perangkat online yang berlangganan topik tertentu.
Anda dapat memanggil operasi ini hingga 1 kali per menit per akun untuk menyiarkan pesan ke semua perangkat online dari suatu produk.

Catatan

Pengguna Manajemen Akses Sumber Daya (RAM) dari suatu Akun Alibaba Cloud berbagi kuota akun tersebut.

Debugging

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 untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Wajib	Contoh	Deskripsi
Action	String	Ya	PubBroadcast	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke PubBroadcast.
MessageContent	String	Ya	aGVsbG93b3JsZA	Konten pesan yang ingin Anda kirim. Ukuran pesan tidak boleh melebihi 64 KB. Untuk menghasilkan konten pesan, konversikan pesan mentah menjadi data biner dan lakukan encoding Base64. Catatan Platform IoT mendekode data menggunakan algoritma Base64, lalu mengirimkan pesan yang telah didekode ke perangkat. Dengan cara ini, perangkat tidak perlu mendekode data yang telah diencode Base64.
ProductKey	String	Ya	aldeji3*****	ProductKey dari produk tempat perangkat tersebut terdaftar. ProductKey adalah pengenal unik yang dikeluarkan oleh Platform IoT untuk produk tersebut. Anda dapat melihat informasi semua produk dalam Akun Alibaba Cloud saat ini di Konsol Platform IoT atau dengan memanggil operasi QueryProductList.
IotInstanceId	String	Tidak	iot_instc_pu***_c-v64********	ID instans. Anda dapat melihat instance ID pada halaman Overview di Konsol Platform IoT. Penting Jika instans Anda memiliki ID, Anda harus menentukan parameter ini. Jika tidak, permintaan akan gagal. Jika halaman Overview atau ID tidak dibuat untuk instans Anda, Anda tidak perlu menentukan parameter ini. Untuk informasi selengkapnya, lihat Overview.
TopicFullName	String	Tidak	/broadcast/UPqSxj2vXXX/xxx	Nama topik. Jika Anda tidak menentukan parameter ini, pesan akan didorong ke semua perangkat online yang memiliki ProductKey tertentu. Perangkat menerima pesan dari topik siaran dalam format berikut: `/sys/${productKey}/${deviceName}/broadcast/request/${MessageId}`. Variabel MessageId dihasilkan oleh Platform IoT. Jika Anda menentukan parameter ini, pesan akan didorong ke perangkat yang memiliki ProductKey tertentu dan berlangganan topik yang ditentukan. Anda harus menentukan topik siaran menggunakan sintaks berikut: `/broadcast/${productKey}/Custom field`. Ganti ${productKey} dengan ProductKey dari perangkat yang menerima pesan. Untuk bidang kustom, Anda dapat menentukan nilai sesuai kebutuhan bisnis Anda. Catatan Saat mengembangkan perangkat, Anda hanya perlu menulis kode untuk mendefinisikan topik siaran. Anda tidak perlu membuat topik di Konsol Platform IoT. Maksimal 1.000 perangkat dapat berlangganan satu topik siaran. Jika jumlah perangkat melebihi batas tersebut, Anda dapat membagi perangkat ke dalam kelompok. Misalnya, Anda dapat membagi 5.000 perangkat menjadi 5 kelompok. Setiap kelompok berisi 1.000 perangkat. Dalam kasus ini, Anda harus memanggil operasi PubBroadcast sebanyak lima kali. Setiap kali memanggil operasi, atur bidang kustom dalam topik siaran menjadi group1, group2, group3, group4, dan group5. Pastikan setiap kelompok perangkat berlangganan topik siaran yang ditentukan.

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

Parameter respons

Parameter	Type	Contoh	Deskripsi
Code	String	iot.system.SystemException	Kode kesalahan yang dikembalikan jika permintaan gagal. Untuk informasi selengkapnya, lihat bagian Kode kesalahan dalam topik ini.
ErrorMessage	String	A system exception occurred.	Pesan kesalahan yang dikembalikan jika permintaan gagal.
MessageId	Long	1234291569964771840	ID pesan yang dihasilkan oleh Platform IoT saat pesan dikirim.
RequestId	String	BB71E443-4447-4024-A000-EDE09922891E	ID permintaan.
Success	Boolean	true	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true false

Contoh

Contoh permintaan

https://iot.cn-shanghai.aliyuncs.com/?Action=PubBroadcast
&ProductKey=al**********
&TopicFullName=/broadcast/UPq****/xxx
&MessageContent=aGVsbG93b3JsZA
&<Common request parameters>

Contoh respons sukses

XML format

<PubBroadcastResponse>
        <RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
        <MessageId>1234291569964771840</MessageId>
        <Success>true</Success>
  </PubBroadcastResponse>

JSON format

{
      "RequestId":"BB71E443-4447-4024-A000-EDE09922891E",
      "MessageId":1234291569964771840,
      "Success":true
}

Kode kesalahan

Untuk daftar kode kesalahan, lihat Service error codes.