UpdateRule - IoT Platform - Alibaba Cloud Documentation Center

Memodifikasi aturan tertentu.

Batasan

Setiap Akun Alibaba Cloud dapat menjalankan maksimal 50 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	Type	Wajib	Contoh	Deskripsi
Action	String	Ya	UpdateRule	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke UpdateRule.
RuleId	Long	Ya	100000	ID aturan yang ingin Anda modifikasi. Anda dapat login ke Konsol IoT Platform dan pilih Rules > Data Forwarding untuk melihat ID aturan tersebut. Anda juga dapat memanggil operasi ListRule dan melihat ID aturan dalam respons.
IotInstanceId	String	Tidak	iot-cn-0pp1n8t****	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 menetapkan parameter ini, pemanggilan akan gagal. Jika instans Anda tidak memiliki halaman Overview atau ID, Anda tidak perlu menetapkan parameter ini. Untuk informasi selengkapnya, lihat Overview.
Select	String	Tidak	deviceName() as deviceName, items.Humidity.value as Humidity, items.Temperature.value as Temperature	Pernyataan SQL SELECT yang akan dieksekusi. Untuk informasi selengkapnya, lihat SQL expressions. Catatan Tentukan konten yang mengikuti kata kunci SELECT untuk parameter ini. Misalnya, jika pernyataan SELECT adalah `SELECT a,b,c`, tentukan `a,b,c` untuk parameter ini.
ShortTopic	String	Tidak	+/thing/event/property/post	Topik tempat aturan ini diterapkan. Sintaks: `${deviceName}/topicShortName`. `${deviceName}` menentukan nama perangkat, dan `topicShortName` menentukan nama kustom topik tersebut. Topik komunikasi dasar atau topik komunikasi berbasis Thing Specification Language (TSL). Sintaks: `${deviceName}/topicShortName`. Anda dapat mengganti `${deviceName}` dengan wildcard `+`. Wildcard tersebut menunjukkan bahwa topik berlaku untuk semua perangkat di bawah produk tersebut. Nilai valid untuk `topicShortName`: `/thing/event/property/post`: mengirimkan data properti perangkat. `/thing/event/${tsl.event.identifier}/post`: mengirimkan data event perangkat. `${tsl.event.identifier}` menentukan identifier event dalam model TSL. `/thing/lifecycle`: mengirimkan perubahan siklus hidup perangkat. `/thing/downlink/reply/message`: mengirimkan respons terhadap permintaan dari IoT Platform. `/thing/list/found`: mengirimkan data saat gerbang mendeteksi perangkat sub baru. `/thing/topo/lifecycle`: mengirimkan perubahan topologi perangkat. `/thing/event/property/history/post`: mengirimkan data properti historis perangkat. `/thing/event/${tsl.event.identifier}/post`: mengirimkan data event historis perangkat. `${tsl.event.identifier}` menentukan identifier event dalam TSL. `/ota/upgrade`: mengirimkan status Pembaruan OTA. `/ota/version/post`: mengirimkan versi modul OTA. `/thing/deviceinfo/update`: mengirimkan perubahan Tag perangkat. `/edge/driver/${driver_id}/point_post`: mengirimkan data transmisi langsung dari Link IoT Edge. `${driver_id}` menentukan ID driver yang digunakan perangkat untuk mengakses Link IoT Edge. `${packageId}/${jobId}/ota/job/status`: mengirimkan status batch Pembaruan OTA. Topik ini merupakan topik komunikasi dasar. `${packageId}` menentukan ID paket pembaruan. `${jobId}` menentukan ID batch pembaruan. Topik kustom. Contoh: `${deviceName}/user/get`. Anda dapat memanggil operasi QueryProductTopic untuk melihat semua topik kustom produk tersebut. Saat menentukan topik kustom, Anda dapat menggunakan wildcard `+` dan `#`. Anda dapat mengganti `${deviceName}` dengan wildcard `+`. Wildcard tersebut menunjukkan bahwa topik berlaku untuk semua perangkat di bawah produk tersebut. Anda dapat mengganti field yang mengikuti ${deviceName} dengan `/user/#`. Wildcard `#` menunjukkan bahwa topik berlaku apa pun nilai yang ditentukan untuk field yang mengikuti`/user`. Untuk informasi selengkapnya tentang penggunaan wildcard, lihat Wildcards in topics. Topik yang digunakan untuk mengirimkan perubahan status perangkat: `${deviceName}`. Anda dapat menggunakan wildcard `+`. Dalam kasus ini, perubahan status semua perangkat di bawah produk tersebut akan dikirimkan.
Where	String	Tidak	Temperature>35	Kondisi yang digunakan untuk memicu aturan tersebut. Untuk informasi selengkapnya, lihat SQL expressions. Catatan Tentukan konten yang mengikuti kata kunci WHERE untuk parameter ini. Misalnya, jika pernyataan WHERE adalah `WHERE a>10`, tentukan `a>10` untuk parameter ini.
ProductKey	String	Tidak	aladaeW****	ProductKey produk tempat aturan tersebut diterapkan.
Name	String	Tidak	test_2	Nama aturan tersebut. Nama aturan harus terdiri dari 1 hingga 30 karakter, dan dapat berisi huruf, angka, garis bawah (_), serta tanda hubung (-).
RuleDesc	String	Tidak	test	Deskripsi aturan tersebut. Deskripsi dapat mencapai panjang maksimum 100 karakter.
TopicType	Integer	Tidak	1	0: Topik tersebut merupakan topik komunikasi dasar atau topik komunikasi berbasis TSL. 1: Topik tersebut merupakan topik kustom. 2: Topik tersebut digunakan untuk mengirimkan perubahan status perangkat. Sintaks: `/as/mqtt/status/${productKey}/${deviceName}`.
Topic	String	Tidak	/sys/g18l***/device1/thing/event/property/post	Topik lengkap tempat aturan tersebut diterapkan. Jika Anda menentukan parameter ini, Anda tidak perlu menentukan parameter ProductKey, ShortTopic, dan TopicType.

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

Parameter respons

Parameter	Type	Contoh	Deskripsi
Code	String	iot.system.SystemException	Kode kesalahan yang dikembalikan jika pemanggilan gagal. Untuk informasi selengkapnya, lihat Error codes.
ErrorMessage	String	A system exception occurred.	Pesan kesalahan yang dikembalikan jika pemanggilan gagal.
RequestId	String	9A2F243E-17FE-4846-BAB5-D02A25155AC4	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=UpdateRule
&RuleId=100000
&Name=test_2
&ProductKey=aladaeW****
&ShortTopic=+/thing/event/property/post
&Select=deviceName() as deviceName, items.Humidity.value as Humidity, items.Temperature.value as Temperature
&RuleDesc=test
&Where=a>10
&TopicType=1
&<Common request parameters>

Contoh respons sukses

XML format

<UpdateRuleResponse>
      <RequestId>9A2F243E-17FE-4874-QBB5-D02A25155AC8</RequestId>
      <Success>true</Success>
</UpdateRuleResponse>

JSON format

{
    "RequestId":"9A2F243E-17FE-4846-BAB5-D02A25155AC4",
    "Success":true
}

Kode kesalahan

Untuk daftar kode kesalahan, kunjungi API Error Center.