GetRule - IoT Platform - Alibaba Cloud Documentation Center

Mengambil informasi detail tentang aturan tertentu.

Batasan

Setiap Akun Alibaba Cloud dapat menjalankan maksimal 50 kueri 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	Tipe	Wajib	Contoh	Deskripsi
Action	String	Ya	GetRule	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke GetRule.
RuleId	Long	Ya	100000	ID aturan yang ingin Anda kueri. Anda dapat login ke Konsol IoT Platform dan memilih 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 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.

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

Parameter respons

Parameter	Tipe	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	58D4CEC0-3E95-4DBE-AFC1-809D1400E52F	ID permintaan.
RuleInfo	Struct		Informasi aturan yang dikembalikan jika pemanggilan berhasil. Untuk informasi selengkapnya, lihat RuleInfo.
CreateUserId	Long	100000000000000	ID pengguna yang membuat aturan tersebut.
Created	String	Thu Feb 28 14:14:33 CST 2019	Waktu saat aturan dibuat. Waktu ditampilkan dalam UTC-6.
DataType	String	JSON	Tipe data aturan. Nilai yang valid: JSON dan BINARY.
Id	Long	100000	ID aturan.
Modified	String	Thu Feb 28 14:20:58 CST 2019	Waktu terakhir aturan dimodifikasi. Waktu ditampilkan dalam UTC-6.
Name	String	iotrules	Nama aturan.
ProductKey	String	a1KiV******	ProductKey produk tempat aturan diterapkan.
RuleDesc	String	rule1Desc	Deskripsi aturan ini.
Select	String	deviceName() as deviceName	Nilai Select dalam Pernyataan SQL aturan.
ShortTopic	String	+/user/pm25data	Topik tempat aturan diterapkan. Topik ini tidak mencakup level ProductKey. Format: `${deviceName}/topicShortName`. ${deviceName} menunjukkan nama perangkat, dan topicShortName menunjukkan nama kustom topik. Catatan Untuk informasi tentang cara menggunakan wildcard `+` atau `#` dalam topik, lihat Topic wildcards.
Status	String	STOP	Status aturan. Nilai yang valid: RUNNING: Running STOP: Dihentikan
Topic	String	/a1QsMlL44pp/+/user/pm25data	Topik lengkap tempat aturan diterapkan. Format: `${productKey}/${deviceName}/topicShortName`. Catatan Untuk informasi tentang cara menggunakan wildcard `+` atau `#` dalam topik, lihat Topic wildcards.
TopicType	Integer	1	Tipe topik. Parameter ini dikembalikan jika Anda menyetel Pernyataan SQL untuk aturan. Nilai yang valid: 0: topik komunikasi dasar atau topik komunikasi TSL. 1: topik kustom. 2: topik status perangkat. Jika tidak ada Pernyataan SQL yang disetel untuk aturan, nilai -1 dikembalikan.
UtcCreated	String	2019-02-28T06:14:33.000Z	Waktu saat aturan dibuat. Waktu ditampilkan dalam UTC.
UtcModified	String	2019-02-28T06:20:58.000Z	Waktu terakhir aturan dimodifikasi. Waktu ditampilkan dalam UTC.
Where	String	Temperature>35	Kondisi kueri Where dalam Pernyataan SQL aturan.
Success	Boolean	true	Menunjukkan apakah pemanggilan berhasil. true: Pemanggilan berhasil. false: Pemanggilan gagal.

Contoh

Permintaan contoh

https://iot.cn-shanghai.aliyuncs.com/?Action=GetRule
&RuleId=100000
&<Common request parameters>

Respons sukses contoh

XML format

<GetRuleResponse>
  <RequestId>85648524-E5EE-418E-BD16-FAFBB4FF3645</RequestId>
  <Success>true</Success>
  <RuleInfo>
        <DataType>JSON</DataType>
        <ShortTopic>+/user/pm25data</ShortTopic>
        <ProductKey>a1QsMl****</ProductKey>
        <UtcModified>2019-12-23T03:34:45.000Z</UtcModified>
        <CreateUserId>198426864326****</CreateUserId>
        <UtcCreated>2019-12-23T02:32:06.000Z</UtcCreated>
        <Name>Ruff_rule1</Name>
        <Status>RUNNING</Status>
        <Select>deviceName() as deviceName , timestamp('yyyy-MM-dd HH:mm:ss') as time, pm25, pm10</Select>
        <Created>Mon Dec 23 10:32:06 CST 2019</Created>
        <Modified>Mon Dec 23 11:34:45 CST 2019</Modified>
        <TopicType>1</TopicType>
        <Topic>/a1QsMlL****/+/user/pm25data</Topic>
        <Id>425367</Id>
  </RuleInfo>
</GetRuleResponse>

JSON format

{
    "RequestId": "85648524-E5EE-418E-BD16-FAFBB4FF3645",
    "Success": true,
    "RuleInfo": {
        "DataType": "JSON",
        "ShortTopic": "+/user/pm25data",
        "ProductKey": "a1QsMl****",
        "UtcModified": "2019-12-23T03:34:45.000Z",
        "CreateUserId": "198426864326****",
        "UtcCreated": "2019-12-23T02:32:06.000Z",
        "Name": "Ruff_rule1",
        "Status": "RUNNING",
        "Select": "deviceName() as deviceName , timestamp('yyyy-MM-dd HH:mm:ss') as time, pm25, pm10",
        "Created": "Mon Dec 23 10:32:06 CST 2019",
        "Modified": "Mon Dec 23 11:34:45 CST 2019",
        "TopicType": 1,
        "Topic": "/a1QsMlL****/+/user/pm25data",
        "Id": 425367
    }
}

Kode kesalahan

Untuk daftar kode kesalahan, kunjungi API Error Center.