GetGatewayBySubDevice - IoT Platform - Alibaba Cloud Documentation Center

Mengambil informasi gateway berdasarkan informasi perangkat sub.

Batasan

Setiap Akun Alibaba Cloud dapat menjalankan maksimal 50 permintaan 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	GetGatewayBySubDevice	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke GetGatewayBySubDevice.
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, pemanggilan akan gagal. Jika instans Anda tidak memiliki halaman Overview atau ID, Anda tidak perlu menetapkan parameter ini. Untuk informasi selengkapnya, lihat Overview.
ProductKey	String	Tidak	a1BwAGV****	KunciProduk dari produk tempat perangkat tersebut terdaftar. Catatan Jika Anda menentukan parameter ini, Anda juga harus menentukan parameter DeviceName.
DeviceName	String	Tidak	light	NamaPerangkat dari perangkat sub. Catatan Jika Anda menentukan parameter ini, Anda juga harus menentukan parameter ProductKey.
IotId	String	Tidak	Q7uOhVRdZRRlDnTLv****00100	ID Perangkat sub. ID ini merupakan pengenal unik yang dikeluarkan oleh IoT Platform untuk Perangkat sub tersebut. Catatan Jika Anda menentukan parameter ini, Anda tidak perlu menentukan ProductKey atau DeviceName. Parameter IotId menentukan ID Unik Global (GUID) dari perangkat, yang berkorespondensi dengan kombinasi ProductKey dan DeviceName. Jika Anda menentukan baik IotId maupun kombinasi ProductKey dan DeviceName, IotId akan diutamakan.

Selain parameter permintaan khusus 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 gateway yang dikembalikan jika pemanggilan berhasil.
DeviceName	String	gateway	NamaPerangkat gerbang.
DeviceSecret	String	dCYdTU3gw5Z77bsHjPk6lPHPVnBT****	RahasiaPerangkat dari gerbang.
FirmwareVersion	String	V1.0.1	Nomor versi firmware Perangkat.
GmtActive	String	2019-12-18 23:25:30	Waktu aktivasi gerbang. Waktu ditampilkan dalam GMT. Waktu tersebut merupakan waktu lokal Wilayah tempat gerbang berada.
GmtCreate	String	2019-12-18 16:58:33	Waktu pembuatan gerbang. Waktu ditampilkan dalam GMT. Waktu tersebut merupakan waktu lokal Wilayah tempat gerbang berada.
GmtOnline	String	2020-01-20 17:41:04	Waktu terakhir gerbang online. Waktu ditampilkan dalam GMT. Waktu tersebut merupakan waktu lokal Wilayah tempat gerbang berada.
IpAddress	String	106..1.**	Alamat IP gerbang.
NodeType	String	1	Jenis node. Nilai 1 menunjukkan bahwa Perangkat tersebut adalah gerbang.
ProductKey	String	a1BwAGV****	ProductKey produk tempat gateway tersebut terdaftar.
ProductName	String	LinkIoT	Nama produk tempat gateway tersebut terdaftar.
Status	String	online	Status perangkat gateway. Nilai yang valid: online: Perangkat sedang online. offline: Perangkat sedang offline. unactive: Perangkat belum diaktifkan. disable: Perangkat dinonaktifkan.
UtcActive	String	2019-12-18T15:25:30.176Z	Waktu aktivasi gateway. Waktu ditampilkan dalam UTC. Waktu aktual wilayah tempat gateway berada dihitung berdasarkan zona waktu wilayah tersebut.
UtcCreate	String	2019-12-18T08:58:33.000Z	Waktu pembuatan gateway. Waktu ditampilkan dalam UTC. Waktu aktual wilayah tempat gateway berada dihitung berdasarkan zona waktu wilayah tersebut.
UtcOnline	String	2020-01-20T09:41:04.879Z	Waktu terakhir gateway online. Waktu ditampilkan dalam UTC. Waktu aktual wilayah tempat gateway berada dihitung berdasarkan zona waktu wilayah tersebut.
iotId	String	WuyjPSDQE1L22z1d****000100	ID perangkat gateway. ID ini merupakan pengenal unik yang dikeluarkan oleh IoT Platform untuk perangkat tersebut.
region	String	cn-shanghai	Wilayah tempat gateway berada. Wilayah ini sesuai dengan wilayah yang ditampilkan di Konsol IoT Platform.
ErrorMessage	String	A system exception occurred.	Pesan kesalahan yang dikembalikan jika pemanggilan gagal.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	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=GetGatewayBySubDevice
&ProductKey=a1BwAGV****
&DeviceName=XTzosqEOgxFXKPRgd8zl
&<Common request parameters>

Contoh respons sukses

XML format

<GetGatewayBySubDeviceResponse>
  <Data>
        <region>cn-shanghai</region>
        <DeviceName>gateway_04</DeviceName>
        <GmtActive>2019-12-18 23:25:30</GmtActive>
        <ProductKey>a1vL7cp****</ProductKey>
        <IpAddress>106.**.1**.**</IpAddress>
        <GmtCreate>2019-12-18 16:58:33</GmtCreate>
        <UtcCreate>2019-12-18T08:58:33.000Z</UtcCreate>
        <UtcOnline>2020-01-20T09:41:04.879Z</UtcOnline>
        <UtcActive>2019-12-18T15:25:30.176Z</UtcActive>
        <Status>online</Status>
        <NodeType>1</NodeType>
        <GmtOnline>2020-01-20 17:41:04</GmtOnline>
        <ProductName>LinkIoTEdge_Gateway</ProductName>
        <iotId>WuyjPSDQE1L22z1****000100</iotId>
  </Data>
  <RequestId>0377D5A9-BDE1-48C2-96C9-BDC048899186</RequestId>
  <Success>true</Success>
</GetGatewayBySubDeviceResponse>

JSON format

{
    "Data": {
        "region": "cn-shanghai",
        "DeviceName": "gateway_04",
        "GmtActive": "2019-12-18 23:25:30",
        "ProductKey": "a1vL7cp****",
        "IpAddress": "106.**.1**.**",
        "GmtCreate": "2019-12-18 16:58:33",
        "UtcCreate": "2019-12-18T08:58:33.000Z",
        "UtcOnline": "2020-01-20T09:41:04.879Z",
        "UtcActive": "2019-12-18T15:25:30.176Z",
        "Status": "online",
        "NodeType": 1,
        "GmtOnline": "2020-01-20 17:41:04",
        "ProductName": "LinkIoTEdge_Gateway",
        "iotId": "WuyjPSDQE1L22z1****000100"
    },
    "RequestId": "0377D5A9-BDE1-48C2-96C9-BDC048899186",
    "Success": true
}

Kode kesalahan

Untuk daftar kode kesalahan, kunjungi API Error Center.