QueryDeviceGroupInfo - IoT Platform - Alibaba Cloud Documentation Center

Mengkueri detail suatu kelompok.

Batasan

Setiap Akun Alibaba Cloud dapat menjalankan maksimal 30 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 kemudahan 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	QueryDeviceGroupInfo	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke QueryDeviceGroupInfo.
GroupId	String	Ya	tDQvBJqbUyHs****	ID kelompok. ID ini merupakan identifier unik global (GUID) untuk kelompok tersebut. Anda dapat memanggil operasi QueryDeviceGroupList untuk mengkueri parameter GroupId.
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 Ikhtisar atau ID, Anda tidak perlu mengatur parameter ini. Untuk informasi selengkapnya, lihat Overview.
GroupType	String	Tidak	LINK_PLATFORM_DYNAMIC	Jenis kelompok. Atur nilainya ke LINK_PLATFORM_DYNAMIC. Nilai ini menunjukkan kelompok dinamis. Jika Anda tidak menentukan parameter ini, kelompok statis akan diambil secara default.

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 pemanggilan gagal. Untuk informasi selengkapnya, lihat Kode kesalahan.
Data	Struct		Detail kelompok yang dikembalikan jika pemanggilan berhasil. Parameter ini mencakup parameter berikut.
DeviceActive	Integer	1	Jumlah perangkat yang diaktifkan.
DeviceCount	Integer	10	Jumlah total perangkat.
DeviceOnline	Integer	0	Jumlah perangkat online.
DynamicGroupExpression	String	product_key = "a1***" and name LIKE "test%"	Aturan kelompok dinamis. Parameter ini dikembalikan jika kelompok dinamis dikueri.
GroupDesc	String	usefulGroup	Deskripsi kelompok.
GroupId	String	tDQvBJqbUyHs****	ID kelompok.
GroupName	String	aliyun	Nama kelompok.
UtcCreate	String	2018-09-14T14:35:51.000Z	Waktu pembuatan kelompok.
ErrorMessage	String	A system exception occurred.	Pesan kesalahan yang dikembalikan jika pemanggilan gagal.
RequestId	String	7411716B-A488-4EEB-9AA0-6DB05AD2491F	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=QueryDeviceGroupInfo
&GroupId=tDQvBJqbUyHs****
&<Common request parameters>

Contoh respons sukses

XML format

<QueryDeviceGroupInfoResponse>
<RequestId>7411716B-A488-4EEB-9AA0-6DB05AD2491F</RequestId>
<Data>
    <GroupName>aliyun</GroupName>
    <UtcCreate>2021-10-14T14:35:51.000Z</UtcCreate>
    <DeviceOnline>0</DeviceOnline>
    <GroupDesc>usefulGroup</GroupDesc>
    <DeviceActive>1</DeviceActive>
    <DynamicGroupExpression>product_key = "a1***" and name LIKE "test%"</DynamicGroupExpression>
    <DeviceCount>10</DeviceCount>
    <GroupId>tDQvBJqbUyHs****</GroupId>
</Data>
<Success>true</Success>
</QueryDeviceGroupInfoResponse>

JSON format

{
    "RequestId": "7411716B-A488-4EEB-9AA0-6DB05AD2491F",
    "Data": {
        "GroupName": "aliyun",
        "UtcCreate": "2021-10-14T14:35:51.000Z",
        "DeviceOnline": 0,
        "GroupDesc": "usefulGroup",
        "DeviceActive": 1,
        "DynamicGroupExpression": "product_key = \"a1***\" and name LIKE \"test%\"",
        "DeviceCount": 10,
        "GroupId": "tDQvBJqbUyHs****"
    },
    "Success": true
}

Kode kesalahan

Untuk daftar kode kesalahan, kunjungi API Error Center.