IoT Platform:CreateRule

Parameter

Type

Required

Example

Description

Action

String

Yes

CreateRule

Operasi yang ingin Anda lakukan. Tetapkan nilainya ke CreateRule.

Name

String

Yes

iot_test1

Nama aturan penerusan data. Nama aturan harus terdiri dari 1 hingga 30 karakter, dan dapat berisi huruf, angka, garis bawah (_), serta tanda hubung (-).

IotInstanceId

String

No

iot-cn-0pp1n8t****

ID instans. Anda dapat melihat ID instans pada tab Overview di Konsol IoT Platform.

Untuk informasi selengkapnya tentang instans, lihat Overview.

Select

String

No

deviceName() as deviceName, items.Humidity.value as Humidity, items.Temperature.value as Temperature

Pernyataan SQL SELECT yang ingin Anda eksekusi. Untuk informasi selengkapnya, lihat SQL statements.

ShortTopic

String

No

+/thing/event/property/post

Topik tempat aturan ini diterapkan. Formatnya adalah ${deviceName}/topicShortName. ${deviceName} menentukan nama perangkat, dan topicShortName menentukan nama pendek topik.

• Untuk topik komunikasi dasar atau topik komunikasi berbasis Thing Specification Language (TSL), formatnya adalah ${deviceName}/topicShortName. Anda dapat mengganti ${deviceName} dengan karakter wildcard +. Karakter wildcard ini 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 suatu event dalam model TSL.

  • /thing/lifecycle: mengirimkan perubahan siklus hidup perangkat.

  • /thing/downlink/reply/message: mengirimkan respons perangkat 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}/history/post: mengirimkan data event historis perangkat. ${tsl.event.identifier} menentukan identifier suatu event dalam model TSL.

  • /ota/upgrade: mengirimkan status pembaruan OTA perangkat.

  • /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.

    Untuk topik yang digunakan untuk mengirimkan status batch pembaruan OTA, formatnya adalah ${packageId}/${jobId}/ota/job/status. Topik ini termasuk dalam topik komunikasi dasar. ${packageId} menentukan ID paket. ${jobId} menentukan ID batch pembaruan.

• Untuk topik kustom, contohnya adalah ${deviceName}/user/get.

  Anda dapat memanggil operasi QueryProductTopic untuk melihat semua topik kustom produk tersebut.

  Saat menentukan topik kustom, Anda dapat menggunakan karakter wildcard + dan #.

  • Anda dapat mengganti ${deviceName} dengan karakter wildcard +. Karakter wildcard ini menunjukkan bahwa topik berlaku untuk semua perangkat dalam produk tersebut.

  • Anda dapat mengganti field yang mengikuti ${deviceName} dengan /user/#. Karakter wildcard # menunjukkan bahwa topik berlaku untuk semua field yang mengikuti/user.

    Untuk informasi selengkapnya tentang cara menggunakan karakter wildcard, lihat Use custom topics.

• Untuk topik yang digunakan untuk mengirimkan perubahan status perangkat, formatnya adalah ${deviceName}.

  Anda dapat menggunakan karakter wildcard +. Dalam hal ini, perubahan status semua perangkat di bawah produk tersebut akan dikirimkan.

Where

String

No

Temperature>35

Kondisi yang digunakan untuk memicu aturan. Untuk informasi selengkapnya tentang aturan tersebut, lihat SQL statements.

ProductKey

String

No

a1T27vz****

ProductKey produk tempat aturan ini diterapkan.

RuleDesc

String

No

rule test

Deskripsi aturan. Deskripsi dapat terdiri dari maksimal 100 karakter.

DataType

String

No

JSON

Format data yang diproses berdasarkan aturan. Nilai parameter ini harus konsisten dengan format data perangkat yang ingin Anda proses. Nilai yang valid:

• JSON (default): data JSON.

• BINARY: data biner.

TopicType

Integer

No

1

• 0: topik komunikasi dasar atau topik komunikasi berbasis TSL yang dijelaskan dalam ShortTopic. Topik yang digunakan untuk mengirimkan status batch pembaruan OTA termasuk dalam topik komunikasi dasar.

• 1: topik kustom.

• 2: topik yang digunakan untuk mengirimkan perubahan status perangkat. Topik ini dinyatakan dalam format lengkap berikut: /as/mqtt/status/${productKey}/${deviceName}.

ResourceGroupId

String

No

rg-acfmxazb4ph****

ID kelompok sumber daya.

Topic

String

No

/sys/g18l***/device1/thing/event/property/post

Topik lengkap tempat aturan ini diterapkan.

Jika Anda menentukan parameter ini, Anda tidak perlu menentukan ShortTopic dan TopicType.

Parameter

Type

Example

Description

Code

String

iot.system.SystemException

Kode kesalahan yang dikembalikan jika permintaan gagal. Untuk informasi selengkapnya, lihat Error codes.

ErrorMessage

String

A system exception occurred.

Pesan kesalahan yang dikembalikan jika permintaan gagal.

RequestId

String

E4C0FF92-2A86-41DB-92D3-73B60310D25E

ID permintaan.

RuleId

Long

100000

ID aturan. Jika permintaan berhasil, mesin aturan akan menghasilkan ID aturan untuk aturan tersebut.

Success

Boolean

true

Menunjukkan apakah permintaan berhasil. Nilai yang valid:

• true

• false