QueryProduct - IoT Platform - Alibaba Cloud Dokümantasyon Merkezi

Bir ürünün ayrıntılarını sorgular.

Sınırlamalar

Her Alibaba Cloud hesabı saniyede en fazla 50 sorgu (QPS) gerçekleştirebilir.

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 içinde çağırmanızı öneririz. OpenAPI Explorer, farklı SDK'lar için işlem örnek kodunu dinamik olarak oluşturur.

İstek parametreleri

Parametre	Tür	Gerekli	Örnek	Açıklama
Action	String	Evet	QueryProduct	Gerçekleştirmek istediğiniz işlem. Değeri QueryProduct olarak ayarlayın.
ProductKey	String	Evet	a1BwAGV****	Sorgulamak istediğiniz ürünün ProductKey değeri. ProductKey, IoT Platform tarafından bir ürüne verilen genel benzersiz tanımlayıcıdır (GUID). Mevcut hesaptaki tüm ürünlerin bilgilerini görüntülemek için IoT Platform konsolunu kullanabilir veya QueryProductList işlemini çağırabilirsiniz.
IotInstanceId	String	Hayır	iot_instc_pu***_c-v64********	Örneğin ID değeri. IoT Platform konsolundaki Overview sayfasında örnek ID değerini görüntüleyebilirsiniz. Önemli Örneğinizin bir ID değeri varsa bu parametreyi yapılandırmanız gerekir. Bu parametreyi ayarlamazsanız çağrı başarısız olur. Örneğinizde Overview sayfası veya ID yoksa bu parametreyi ayarlamanız gerekmez. Daha fazla bilgi için bkz. Overview.

Yukarıdaki işleme özel istek parametrelerine ek olarak, bu işlemi çağırırken ortak istek parametrelerini de belirtmeniz gerekir. Daha fazla bilgi için bkz. Common request parameters.

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. Error codes.
Data	Struct		Çağrı başarılı olursa döndürülen ürün bilgileri.
AliyunCommodityCode	String	iothub_senior	Ürünün türü. Bu parametre, bir Nesne Tanımlama Dili (TSL) modeli kullanılıp kullanılmadığını gösterir. Geçerli değerler: iothub_senior: TSL modeli kullanıldı. iothub: TSL modeli kullanılmadı.
AuthType	String	secret	Ürünün cihazlarının IoT Platform'a bağlanmak için kullandığı kimlik doğrulama yöntemi. Geçerli değerler: secret: Cihazların kimliğini doğrulamak için DeviceSecret kullanıldı. id2: Cihazların kimliğini doğrulamak için IoT Internet Device ID kullanıldı. x509: Cihazların kimliğini doğrulamak için X.509 sertifikaları kullanıldı.
CategoryKey	String	Lighting	Ürünün ait olduğu kategorinin tanımlayıcısı. Bu parametre, ürün IoT Platform tarafından önceden tanımlanmış standart bir kategorinin TSL modelini kullanıyorsa döndürülür. Bu parametre, AliyunCommodityCode parametresi iothub_senior olarak ayarlandığında kullanılabilir.
CategoryName	String	Street Lamp	Ürün kategorisinin adı. Bu parametre, ürün IoT Platform tarafından önceden tanımlanmış standart bir kategorinin TSL modelini kullanıyorsa döndürülür. Bu parametre, AliyunCommodityCode parametresi iothub_senior olarak ayarlandığında kullanılabilir.
DataFormat	Integer	1	Cihazlar ile IoT Platform arasında veri iletmek için bir iletişim protokolü tarafından kullanılan veri biçimi. Bu parametre, AliyunCommodityCode parametresi iothub_senior olarak ayarlandığında kullanılabilir. Geçerli değerler: 0: custom. Özel seri veri biçimi kullanıldı. Bu durumda cihaz, ikili veri akışları gibi ham verileri gönderebilir. IoT Platform, belirtilen bir veri ayrıştırma komut dosyası kullanarak ham verileri standart Alink JSON verilerine dönüştürür. 1: Alink JSON. Cihazlar ile IoT Platform arasında Alink JSON verileri iletilir. Alink, IoT Platform tarafından önceden tanımlanmış bir veri değişim protokolüdür.
Description	String	Smart street light	Ürünün açıklaması.
DeviceCount	Integer	0	Ürün altındaki cihaz sayısı.
GmtCreate	Long	1581595942000	Ürünün oluşturulduğu zaman. Değer, milisaniye cinsinden bir zaman damgasıdır.
Id2	Boolean	false	IoT Internet Device ID özelliğinin etkin olup olmadığını gösterir. Geçerli değerler: true: IoT Internet Device ID etkinleştirildi. false: IoT Internet Device ID devre dışı bırakıldı.
NetType	Integer	3	Ağ bağlantı yöntemi. Geçerli değerler: 3: Wi-Fi. 6: hücresel ağ (2G/3G/4G/5G). 7: Ethernet. 8: diğerleri.
NodeType	Integer	0	Ürünün düğüm türü. Bu parametre, AliyunCommodityCode parametresi iothub_senior olarak ayarlandığında kullanılabilir. Geçerli değerler: 0: device. Bir cihaza alt cihazlar eklenemez. Bir cihaz IoT Platform'a doğrudan veya bir ağ geçidinin alt cihazı olarak bağlanabilir. 1: gateway. Bir ağ geçidine alt cihazlar eklenebilir. Bir ağ geçidi alt cihazları yönetebilir, alt cihazlarla topolojik ilişkileri koruyabilir ve bu topolojik ilişkileri IoT Platform ile senkronize edebilir.
Owner	Boolean	true	İşlemin ürün sahibi tarafından çağrılıp çağrılmadığını gösterir. true: evet. false: hayır.
ProductKey	String	a1T27vz****	Ürünün ProductKey değeri. Bir ürün oluşturduğunuzda ProductKey, IoT Platform tarafından ürüne verilen genel benzersiz tanımlayıcıdır (GUID).
ProductName	String	Street light	Ürünün adı.
ProductSecret	String	U5tW7i44uilc****	Ürünün ProductSecret değeri.
ProductStatus	String	DEVELOPMENT_STATUS	Ürünün durumu. DEVELOPMENT_STATUS: Ürün geliştirme aşamasındadır. RELEASE_STATUS: Ürün yayımlandı.
ProtocolType	String	modbus	Alt cihazların bir ağ geçidine bağlanmak için kullandığı protokol türü. Bu parametre, AliyunCommodityCode parametresi iothub_senior ve NodeType parametresi 1 olarak ayarlandığında kullanılabilir. Geçerli değerler: modbus: Modbus. opc-ua: OPC UA. customize: özel protokol. ble: BLE. zigbee: ZigBee.
ValidateType	Integer	1	Veri doğrulama düzeyi. Geçerli değerler: 2: doğrulama yok. IoT Platform verileri doğrulamaz. Tüm veriler iletilir. IoT Platform konsolunda veriler, Cihaz Ayrıntıları sayfasının TSL Verileri sekmesinde görüntülenmez. 1: düşük düzeyli doğrulama. IoT Platform yalnızca verilerin identifier ve dataType alanlarını doğrular. Tüm veriler iletilir. 0: yüksek düzeyli doğrulama. IoT Platform verilerin tüm alanlarını doğrular. Yalnızca doğrulamadan geçen veriler iletilir. 14 Ekim 2020'den önce oluşturulan ürünler yalnızca yüksek düzeyli doğrulamayı destekler. 14 Ekim 2020 tarihinde veya sonrasında oluşturulan ürünler düşük düzeyli doğrulamayı veya doğrulama olmamasını destekler. Doğrulama sonrası, doğrulamadan geçen veya doğrulamadan geçemeyen verileri görüntüleyebilirsiniz. IoT Platform konsolunda veriler, Cihaz Ayrıntıları sayfasının TSL Verileri sekmesinde görüntülenir. Doğrulama başarısız olan veriler görüntülenmez. Doğrulama başarısız olan verileri, iletilen verilerin checkFailedData parametresinde görüntüleyebilirsiniz. Daha fazla bilgi için bkz. Veri biçimleri.
ErrorMessage	String	A system exception occurred.	Çağrı başarısız olursa döndürülen hata iletisi.
RequestId	String	E4F94B97-1D64-4080-BFD2-67461667AA43	İsteğin ID değeri.
Success	Boolean	true	Çağrının başarılı olup olmadığını gösterir. true: Çağrı başarılı oldu. false: Çağrı başarısız oldu.

Örnekler

Örnek istekler

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProduct
&ProductKey=a1BwAGV****
&<Common request parameters>

Örnek başarılı yanıt

XML biçimi

<QueryProductResponse>
  <Data>
        <Owner>true</Owner>
        <CategoryName>Street lighting</CategoryName>
        <DataFormat>1</DataFormat>
        <ProductKey>a1BwAGV****</ProductKey>
        <ProductStatus>DEVELOPMENT_STATUS</ProductStatus>
        <GmtCreate>1581595942000</GmtCreate>
        <ProductSecret>U5tW7i44uilc****</ProductSecret>
        <NodeType>0</NodeType>
        <ProductName>Street light</ProductName>
        <ValidateType>1</ValidateType>
        <DeviceCount>0</DeviceCount>
        <NetType>3</NetType>
        <AuthType>secret</AuthType>
        <CategoryKey>Lighting</CategoryKey>
        <Id2>false</Id2>
        <AliyunCommodityCode>iothub_senior</AliyunCommodityCode>
  </Data>
  <RequestId>DA5A3C45-D457-48ED-9A20-AEDEA8503401</RequestId>
  <Success>true</Success>
</QueryProductResponse>

JSON biçimi

{
    "Data": {
        "Owner": true,
        "CategoryName": "Street lighting",
        "DataFormat": 1,
        "ProductKey": "a1BwAGV****",
        "ProductStatus": "DEVELOPMENT_STATUS",
        "GmtCreate": 1581595942000,
        "ProductSecret": "U5tW7i44uilc****",
        "NodeType": 0,
        "ProductName": "Street light"
        "ValidateType":1,
        "DeviceCount": 0,
        "NetType": 3,
        "AuthType": "secret",
        "CategoryKey": "Lighting",
        "Id2": false,
        "AliyunCommodityCode": "iothub_senior"
    },
    "RequestId": "DA5A3C45-D457-48ED-9A20-AEDEA8503401",
    "Success": true
}

Hata kodları

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