ImportDevice - IoT Platform - Alibaba Cloud Dokümantasyon Merkezi

Kullanım notları

Bu işlemi çağırmadan önce bir MQTT ağ geçidi ve ilgili ürünü oluşturduğunuzdan, ayrıca ürünün ProductKey değerini aldığınızdan emin olun.

QPS sınırları

Bu API işlemini hesap başına saniyede en fazla 50 kez çağırabilirsiniz.

Not

RAM kullanıcıları, Alibaba Cloud hesabını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'da ç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	ImportDevice	Gerçekleştirmek istediğiniz işlem. Değeri ImportDevice olarak ayarlayın.
ProductKey	String	Evet	a1BwAGV****	Cihazın ait olduğu ürünün ProductKey değeri.
DeviceName	String	Evet	light	Cihazın DeviceName değeri. DeviceName 4 ila 32 karakter uzunluğunda olmalı; harf, rakam, kısa çizgi (-), alt çizgi (_), at işareti (@), nokta (.) ve iki nokta üst üste (:) içerebilir. DeviceName, ürün içinde benzersiz olmalıdır.
DeviceSecret	String	Evet	b4d43f7******10ba5e5	Cihazın DeviceSecret değeri. DeviceSecret 1 ila 32 karakter uzunluğunda olmalı; harf, rakam, kısa çizgi (-), alt çizgi (_), at işareti (@), nokta (.) ve iki nokta üst üste (:) içerebilir.
Nickname	String	Hayır	Campus light	Cihazın takma adı. Takma ad 1 ila 64 karakter uzunluğunda olmalı; harf, rakam ve alt çizgi (_) içerebilir. Not Bu parametreyi belirtmezseniz IoT Platform cihaz için bir takma ad oluşturmaz.
Sn	String	Hayır	QC4******001	Cihazın seri numarası (SN). SN 1 ila 64 karakter uzunluğunda olmalı; harf, rakam ve alt çizgi (_) içerebilir. Not Bu parametreyi belirtmezseniz IoT Platform cihaz için bir SN oluşturmaz.
IotInstanceId	String	Hayır	iot-1n8t****	Örnek ID'si. ID değerini IoT Platform konsolundaki Overview sayfasında bulabilirsiniz. Önemli Örneğinizin bir ID'si varsa bunu belirtmeniz gerekir; aksi takdirde çağrı başarısız olur. Örneğiniz için bir Overview sayfası veya ID oluşturulmamışsa bu parametreyi belirtmenize gerek yoktur. Daha fazla bilgi için bkz. Overview.

İşleme özel istek parametrelerine ek olarak, bu işlemi çağırırken ortak istek parametrelerini de belirtmeniz gerekir. Daha fazla bilgi için bkz. Ortak parametreler.

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ı olduğunda döndürülen cihaz bilgileri.
DeviceName	String	light	Cihazın DeviceName değeri. Önemli Bu bilgileri gizli tutun.
DeviceSecret	String	b4d43f7******10ba5e5	Cihazın DeviceSecret değeri. Önemli Bu bilgileri gizli tutun.
IotId	String	1O4YPNtRqB2anumz2Canp4GB7*****	IoT Platform tarafından verilen benzersiz cihaz ID'si. Önemli Bu bilgileri gizli tutun.
Nickname	String	Campus light	Cihazın takma adı. Not Cihaz için bir takma ad belirtmezseniz bu parametre boş olur.
ProductKey	String	a1BwAGV****	Cihazın ait olduğu ürünün ProductKey değeri.
Sn	String	QC4******001	Cihazın SN değeri. Not Cihaz için bir SN belirtmezseniz bu parametre boş olur.
ErrorMessage	String	A system exception occurred.	Çağrı başarısız olursa döndürülen hata iletisi.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	İ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ı oldu. false: Çağrı başarısız oldu.

Örnekler

Örnek istekler

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ImportDevice
&DeviceName=device1
&DeviceSecret=b4d43f7******10ba5e5
&ProductKey=a1BwAGV****
&IotInstanceId=iot-1n8t****
&<Common request parameters>

Başarılı yanıt örnekleri

XML biçimi

<ImportDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <IotId>1O4YPNtRqB2anumz2Canp4GB7*****</IotId>
        <DeviceSecret>b4d43f7******10ba5e5</DeviceSecret>
        <Sn>QC4******001</Sn>
        <ProductKey>a1BwAGV****</ProductKey>
        <Nickname>Campus light</Nickname>
        <DeviceName>light</DeviceName>
  </Data>
  <Success>true</Success>
</ImportDeviceResponse>

JSON biçimi

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "IotId": "1O4YPNtRqB2anumz2Canp4GB7*****",
        "DeviceSecret": "b4d43f7******10ba5e5",
        "Sn": "QC4******001",
        "ProductKey": "a1BwAGV****",
        "Nickname": "Campus light",
        "DeviceName": "light"
    },
    "Success": true
}

Hata kodları

HttpCode	Hata kodu	Hata iletisi	Açıklama
200	iot.device.CreateDeviceFailed	An error occurred while creating the device.	Sistem cihazı oluşturamadı.
200	iot.device.AlreadyExistedDeviceName	The DeviceName already exists.	Belirtilen DeviceName zaten ürün içinde mevcut.

Hata kodlarının listesi için bkz. Service error codes.