QueryDeviceByTags - IoT Platform - Alibaba Cloud Documentation Center

Melakukan kueri perangkat berdasarkan tag.

Batasan

Anda dapat menentukan maksimal 10 tag dalam satu panggilan.
Setiap Akun Alibaba Cloud dapat menjalankan maksimal 5 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 memudahkan 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	QueryDeviceByTags	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke QueryDeviceByTags.
Tag.N.TagKey	String	Ya	room	Kunci dari tag perangkat.
Tag.N.TagValue	String	Ya	101	Nilai dari tag perangkat.
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 menetapkan parameter ini, panggilan akan gagal. Jika instans Anda tidak memiliki halaman Overview atau ID, Anda tidak perlu menetapkan parameter ini. Untuk informasi selengkapnya, lihat Overview.
CurrentPage	Integer	Tidak	1	Nomor halaman yang dikembalikan. Nilai default: 1.
PageSize	Integer	Tidak	10	Jumlah entri yang dikembalikan pada setiap halaman. Nilai maksimum: 50. Nilai default: 10.

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

Parameter respons

Parameter	Tipe	Contoh	Deskripsi
Code	String	iot.system.SystemException	Kode kesalahan yang dikembalikan jika panggilan gagal. Untuk informasi selengkapnya, lihat Kode kesalahan.
Data	Array of SimpleDeviceInfo		Informasi perangkat yang dikembalikan jika panggilan berhasil. Parameter SimpleDeviceInfo mencakup detail perangkat.
SimpleDeviceInfo
DeviceName	String	light1	DeviceName perangkat.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	ID perangkat. ID ini merupakan pengenal unik yang dikeluarkan oleh IoT Platform untuk perangkat tersebut.
ProductKey	String	a1BwAGV****	ProductKey produk tempat perangkat tersebut terdaftar.
ProductName	String	lamp	Nama produk.
ErrorMessage	String	A system exception occurred.	Pesan kesalahan yang dikembalikan jika panggilan gagal.
Page	Integer	1	Nomor halaman yang dikembalikan.
PageCount	Integer	1	Jumlah total halaman.
PageSize	Integer	10	Jumlah entri yang dikembalikan pada setiap halaman.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID permintaan.
Success	Boolean	true	Menunjukkan apakah panggilan berhasil. true: Panggilan berhasil. false: Panggilan gagal.
Total	Integer	1	Jumlah total catatan.

Contoh

Contoh permintaan

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceByTags
&CurrentPage=1
&PageSize=10
&Tag.1.TagKey=room
&Tag.1.TagValue=101
&Tag.2.TagKey=city
&Tag.2.TagValue=hangzhou
&<Common request parameters>

Contoh respons sukses

XML format

<QueryDeviceByTags>
  <PageCount>1</PageCount>
  <Data>
        <SimpleDeviceInfo>
              <DeviceName>1102jichu02</DeviceName>
              <ProductKey>a1SM5S1****</ProductKey>
              <IotId>GookTiUcwqRbHosp9Ta10****3a00</IotId>
              <ProductName>TEST</ProductName>
        </SimpleDeviceInfo>
  </Data>
  <PageSize>10</PageSize>
  <Page>1</Page>
  <RequestId>2B5091E4-32D5-4884-A5B2-2E8E713D84AF</RequestId>
  <Success>true</Success>
  <Total>1</Total>
</QueryDeviceByTags>

JSON format

{
    "PageCount": 1,
    "Data": {
        "SimpleDeviceInfo": [
            {
                "DeviceName": "1102jichu02",
                "ProductKey": "a1SM5S1****",
                "IotId": "GookTiUcwqRbHosp9Ta10****3a00",
                "ProductName": "TEST"
            }
        ]
    },
    "PageSize": 10,
    "Page": 1,
    "RequestId": "2B5091E4-32D5-4884-A5B2-2E8E713D84AF",
    "Success": true,
    "Total": 1
}

Kode kesalahan

Untuk daftar kode kesalahan, kunjungi API Error Center.