ListRule - IoT Platform - Alibaba Cloud Documentation Center

Menampilkan daftar aturan berdasarkan halaman.

Batas QPS

Anda dapat memanggil operasi API ini hingga 20 kali per detik per akun.

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	Required	Example	Description
Action	String	Yes	ListRule	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke ListRule.
CurrentPage	Integer	Yes	1	Nomor halaman. Nilai maksimum: 1000. Nilai default: 1.
PageSize	Integer	Yes	2	Jumlah entri per halaman. Nilai valid: 1 hingga 100. Nilai default: 10.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID instans. Anda dapat melihat ID instans pada tab Overview di Konsol IoT Platform. Penting Jika instans memiliki ID, Anda harus menentukan parameter ini. Jika tidak, permintaan akan gagal. Jika tab Overview atau ID instans tidak ditampilkan di Konsol IoT Platform, Anda tidak perlu menentukan parameter ini. Untuk informasi selengkapnya tentang instans, lihat Overview.
ResourceGroupId	String	No	rg-acfmxazb4ph****	ID kelompok sumber daya. Penting IoT Platform hanya mendukung manajemen kelompok sumber daya berdasarkan instans. Parameter ResourceGroupId tidak valid. Anda tidak perlu menentukan parameter ini.

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

Parameter respons

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Kode kesalahan yang dikembalikan jika permintaan gagal. Untuk informasi selengkapnya, lihat Error codes.
Data	Array of RuleInfo		Aturan yang dikembalikan jika permintaan berhasil. Untuk informasi selengkapnya, lihat deskripsi parameter RuleInfo dalam topik ini. Catatan Aturan yang dikembalikan diurutkan secara menurun berdasarkan waktu pembuatan aturan.
RuleInfo
CreateUserId	Long	1231579085000000	ID pengguna yang membuat aturan.
Created	String	Wed Feb 27 20:45:43 CST 2019	Waktu saat aturan dibuat. Waktu ditampilkan dalam UTC-6.
DataType	String	JSON	Tipe data aturan. Nilai valid: JSON dan BINARY.
Id	Long	151454	ID aturan.
Modified	String	Wed Feb 27 20:45:43 CST 2019	Waktu terakhir aturan dimodifikasi. Waktu ditampilkan dalam UTC-6.
Name	String	test123	Nama aturan.
ProductKey	String	a1KiV******	ProductKey produk tempat aturan diterapkan.
RuleDesc	String	rule1Desc	Deskripsi aturan.
Select	String	deviceName() as deviceName	Konten dalam klausa SELECT pada Pernyataan SQL aturan.
ShortTopic	String	+/thing/event/property/post	Nama topik tempat aturan diterapkan, tidak termasuk ProductKey. Nilainya dalam format `${deviceName}/topicShortName`. ${deviceName} menunjukkan nama perangkat, dan topicShortName menunjukkan nama kustom topik. Catatan Nama topik mungkin berisi karakter wildcard `+` atau `#`. Untuk informasi selengkapnya, lihat Topics.
Status	String	STOP	Status aturan. Nilai valid: RUNNING: Aturan sedang berjalan. STOP: Aturan dihentikan.
Topic	String	/a1T27vz****/+/thing/event/property/post	Nama topik tempat aturan diterapkan, termasuk ProductKey. Nilainya dalam format `${productKey}/${deviceName}/topicShortName`. Catatan Nama topik mungkin berisi karakter wildcard `+` atau `#`. Untuk informasi selengkapnya, lihat Topics.
UtcCreated	String	2019-02-27T12:40:43.000Z	Waktu saat aturan dibuat. Waktu ditampilkan dalam UTC.
UtcModified	String	2019-02-27T12:45:43.000Z	Waktu terakhir aturan dimodifikasi. Waktu ditampilkan dalam UTC.
Where	String	Temperature>35	Kondisi dalam klausa WHERE pada Pernyataan SQL aturan.
ErrorMessage	String	A system exception occurred.	Pesan kesalahan yang dikembalikan jika permintaan gagal.
Page	Integer	1	Nomor halaman.
PageSize	Integer	2	Jumlah entri per halaman.
RequestId	String	1564B626-DE97-452D-9E9B-305888AC6105	ID permintaan.
Success	Boolean	true	Menunjukkan apakah permintaan berhasil. Nilai valid: true false
Total	Integer	25	Total jumlah halaman yang dikembalikan.

Contoh

Permintaan contoh

https://iot.cn-shanghai.aliyuncs.com/?Action=ListRule
&PageSize=2
&CurrentPage=1
&<Common request parameters>

Respons sukses contoh

XML format

<ListRuleResponse>
  <Data>
        <RuleInfo>
              <DataType>JSON</DataType>
              <ProductKey>a1T27vz****</ProductKey>
              <CreateUserId>198426864326****</CreateUserId>
              <UtcModified>2020-02-26T06:38:27.000Z</UtcModified>
              <UtcCreated>2020-02-26T02:50:44.000Z</UtcCreated>
              <Where>Temperature&gt;35</Where>
              <Name>testrule2</Name>
              <Status>STOP</Status>
              <Select>deviceName() as DeviceName</Select>
              <Created>Wed Feb 26 10:50:44 CST 2020</Created>
              <Modified>Wed Feb 26 14:38:27 CST 2020</Modified>
              <Topic>/a1T27vz****/+/thing/event/property/post</Topic>
              <Id>497350</Id>
        </RuleInfo>
  </Data>
  <Page>1</Page>
  <PageSize>1</PageSize>
  <RequestId>1A6131EC-7504-4673-B997-DEFC6B363A37</RequestId>
  <Success>true</Success>
  <Total>5</Total>
</ListRuleResponse>

JSON format

{
	"Data": {
		"RuleInfo": [
			{
				"DataType": "JSON",
				"ProductKey": "a1T27vz****",
				"CreateUserId": "198426864326****",
				"UtcModified": "2020-02-26T06:38:27.000Z",
				"UtcCreated": "2020-02-26T02:50:44.000Z",
				"Where": "Temperature>35",
				"Name": "testrule2",
				"Status": "STOP",
				"Select": "deviceName() as DeviceName",
				"Created": "Wed Feb 26 10:50:44 CST 2020",
				"Modified": "Wed Feb 26 14:38:27 CST 2020",
				"Topic": "/a1T27vz****/+/thing/event/property/post",
				"Id": 497350
			}
		]
	},
	"Page": 1,
	"PageSize": 1,
	"RequestId": "1A6131EC-7504-4673-B997-DEFC6B363A37",
	"Success": true,
	"Total": 5
}

Kode kesalahan

Untuk daftar kode kesalahan, lihat Service error codes.