GetThingTopo - IoT Platform - Alibaba Cloud Dokümantasyon Merkezi

Sınırlamalar

Her Alibaba Cloud hesabı saniyede en fazla 500 sorgu (QPS) gönderebilir.

Not

Bir Alibaba Cloud hesabının RAM kullanıcıları, hesabın kotasını paylaşır.

Hata Ayıklama

OpenAPI Explorer imza değerini otomatik olarak hesaplar. Kolaylık sağlaması açısından bu işlemi OpenAPI Explorer üzerinden çağırmanızı öneririz. OpenAPI Explorer, farklı SDK'lar için örnek kodu dinamik olarak oluşturur.

İstek parametreleri

Parametre	Tür	Gerekli	Örnek	Açıklama
Action	String	Evet	GetThingTopo	Gerçekleştirmek istediğiniz işlem. Değeri GetThingTopo olarak belirtin.
PageNo	Integer	Evet	1	Döndürülecek sayfanın numarası.
PageSize	Integer	Evet	10	Her sayfada döndürülecek giriş sayısı. Maksimum değer: 50.
IotInstanceId	String	Hayır	iot_instc_pu***_c-v64********	Internet of Things (IoT) hizmet örneğinin ID'si. Bu parametre genel örnekler için gerekli değildir. Ancak kurumsal sürüm örnekleri için bu parametre gereklidir.
ProductKey	String	Hayır	a1BwAGV****	Ağ geçidi cihazının ait olduğu ürünün ProductKey değeri. Not Bu parametreyi belirtirseniz DeviceName parametresini de belirtmeniz gerekir.
DeviceName	String	Hayır	light	Ağ geçidi cihazının adı. Not Bu parametreyi belirtirseniz ProductKey parametresini de belirtmeniz gerekir.
IotId	String	Hayır	Q7uOhVRdZRRlDnTLv****00100	Ağ geçidi cihazının ID'si. Bu ID, IoT Platform tarafından ağ geçidi cihazına verilen benzersiz tanımlayıcıdır. Not Bu parametreyi belirtirseniz ProductKey veya DeviceName parametrelerini belirtmeniz gerekmez. IotId parametresi, cihaz için benzersiz bir tanımlayıcı belirtir ve ProductKey ile DeviceName parametrelerinin birleşimine karşılık gelir. Hem IotId parametresini hem de ProductKey ile DeviceName parametrelerinin birleşimini aynı anda belirtirseniz IotId parametresi öncelik kazanır.

Yukarıdaki işleme özel istek parametrelerine ek olarak, bu API işlemini çağırırken ortak istek parametrelerini de belirtmeniz gerekir. Daha fazla bilgi için bkz. Ortak istek parametreleri.

Yanıt parametreleri

Parametre	Tür	Örnek	Açıklama
Code	String	iot.system.SystemException	Çağrı başarısız olursa döndürülen hata kodu. Daha fazla bilgi için bkz. Hata kodları.
Data	Struct		Çağrı başarılı olursa döndürülen veriler. Daha fazla bilgi için aşağıdaki parametrelere bakın.
CurrentPage	Integer	1	Döndürülen sayfanın sayfa numarası.
List	Array of deviceInfo		Alt cihazın ayrıntıları. Alt cihazın ayrıntıları deviceInfo parametresinde yer alır.
deviceInfo
DeviceName	String	light	Alt cihazın DeviceName değeri.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	Alt cihazın ID'si. Bu ID, IoT Platform tarafından alt cihaza verilen benzersiz tanımlayıcıdır.
ProductKey	String	a1BwAGV****	Alt cihazın ait olduğu ürünün ProductKey değeri.
PageCount	Long	1	Döndürülen toplam sayfa sayısı.
PageSize	Integer	10	Her sayfada döndürülen giriş sayısı.
Total	Long	1	Döndürülen toplam giriş sayısı.
ErrorMessage	String	A system exception occurred.	Çağrı başarısız olursa döndürülen hata mesajı.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	İsteğin ID'si.
Success	Boolean	true	Çağrının başarılı olup olmadığını gösterir. true: Çağrı başarılı. false: Çağrı başarısız.

Örnekler

Örnek istekler

https://iot.cn-shanghai.aliyuncs.com/?Action=GetThingTopo
&ProductKey=a1BwAGV****
&DeviceName=device1
&PageSize=10
&PageNo=1
&<Common request parameters>

Örnek başarılı yanıtlar

XML biçimi

<GetThingTopoResponse>
  <Data>
        <PageCount>1</PageCount>
        <PageSize>2</PageSize>
        <CurrentPage>1</CurrentPage>
        <List>
              <deviceInfo>
                    <DeviceName>APItest</DeviceName>
                    <ProductKey>a1T27vz****</ProductKey>
                    <IotId>vWxNur6BUApsqjv****000100</IotId>
              </deviceInfo>
        </List>
        <Total>1</Total>
  </Data>
  <RequestId>93F05C63-9FD1-4CC8-B0FF-6D6C1A6632D1</RequestId>
  <Success>true</Success>
</GetThingTopoResponse>

JSON biçimi

{
	"Data": {
		"PageCount": 1,
		"PageSize": 2,
		"CurrentPage": 1,
		"List": {
			"deviceInfo": [
				{
					"DeviceName": "APItest",
					"ProductKey": "a1T27vz****",
					"IotId": "vWxNur6BUApsqjv****000100"
				}
			]
		},
		"Total": 1
	},
	"RequestId": "93F05C63-9FD1-4CC8-B0FF-6D6C1A6632D1",
	"Success": true
}

Hata kodları

Hata kodlarının listesi için API Hata Merkezi adresini ziyaret edin.