NotifyAddThingTopo - IoT Platform - Alibaba Cloud Documentation Center

Memberi notifikasi kepada gateway untuk menambahkan hubungan topologis.

Catatan Penggunaan

Respons sukses menunjukkan bahwa perintah penambahan hubungan topologis telah dikirim ke gateway, tetapi tidak menjamin bahwa hubungan tersebut telah berhasil ditambahkan.

Saat mengembangkan gateway, Anda harus berlangganan topik yang digunakan untuk mengirim notifikasi penambahan hubungan topologis. Untuk informasi lebih lanjut mengenai topik dan format pesan, lihat Mengelola hubungan topologis.

Batasan

Setiap Akun Alibaba Cloud dapat menjalankan maksimal 500 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 untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Wajib	Contoh	Deskripsi
Action	String	Ya	NotifyAddThingTopo	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke NotifyAddThingTopo.
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 harus mengonfigurasi parameter ini. Jika Anda 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.
DeviceListStr	String	Tidak	[{"productKey":"a1BwAGV**","deviceName":"device1"},{"IotId":"Q7uOhVRdZRRlDnTLv**00100"}]	Sebuah array JSON berisi informasi identitas perangkat sub. Anda dapat menggunakan kombinasi ProductKey dan DeviceName atau hanya IotId untuk menentukan suatu perangkat, seperti [{"productKey":"a1BwAGxxx","deviceName":"device1"},{"IotId":"Q7uOhxxx"}].
GwIotId	String	Tidak	vWxNur6BUApsqjv****4000100	ID perangkat gateway. ID ini merupakan pengenal unik yang dikeluarkan oleh IoT Platform untuk perangkat tersebut. Catatan Jika Anda menentukan parameter ini, Anda tidak perlu menentukan ProductKey atau DeviceName. Parameter IotId menentukan identifier unik global (GUID) perangkat, yang berkorespondensi dengan kombinasi ProductKey dan DeviceName. Jika Anda menentukan baik IotId maupun kombinasi ProductKey dan DeviceName, IotId akan didahulukan.
GwProductKey	String	Tidak	a1T27vz****	KunciProduk dari produk tempat gerbang tersebut terdaftar. Catatan Jika Anda menentukan parameter ini, Anda juga harus menentukan parameter DeviceName.
GwDeviceName	String	Tidak	gateway	NamaPerangkat dari gerbang. Catatan Jika Anda menentukan parameter ini, Anda juga harus menentukan parameter ProductKey.

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

Parameter respons

Parameter	Type	Contoh	Deskripsi
Code	String	iot.system.SystemException	Kode kesalahan yang dikembalikan jika panggilan gagal. Untuk informasi selengkapnya, lihat Error codes.
Data	Struct		Data yang dikembalikan jika panggilan berhasil.
MessageId	String	5443123	ID paket yang dikirim oleh IoT Platform ke gerbang. Paket tersebut digunakan untuk memberi tahu gerbang agar menambahkan topologi.
ErrorMessage	String	A system exception occurred.	Pesan error yang dikembalikan jika panggilan gagal.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID dari permintaan tersebut.
Success	Boolean	true	Menunjukkan apakah panggilan berhasil atau tidak. true: Panggilan berhasil. false: Panggilan gagal.

Contoh

Contoh permintaan

https://iot.cn-shanghai.aliyuncs.com/?Action=NotifyAddThingTopo
&GwProductKey=aldnfald7a
&GwDeviceName=gateway
&DeviceListStr=[{"productKey":"alabcabcab","deviceName":"device1"},{"IotId":"edAjkIeBSsdfadjjllja***"}]
&<Common request parameters>

Contoh respons sukses

XML format

<NotifyAddThingTopoResponse>
  <RequestId>419A3FC1-B517-4958-9414-5546765FA51F</RequestId>
  <Success>true</Success>
  <Data>
        <MessageId>2345123</MessageId>
  </Data>
</NotifyAddThingTopoResponse>

JSON format

{
  "RequestId":"419A3FC1-B517-4958-9414-5546765FA51F",
  "Success": true,
  "Data": {
     "MessageId": "2345123"
  }
}

Kode kesalahan

Untuk daftar kode kesalahan, kunjungi API Error Center.