ImportDevice - IoT Platform - Alibaba Cloud ドキュメントセンター

MQTT ゲートウェイプロダクトにデバイスを追加します。

使用方法

この操作を呼び出す前に、MQTT ゲートウェイと関連プロダクトが作成済みであり、プロダクトの ProductKey が取得済みであることを確認してください。

QPS 制限

この API 操作は、アカウントごとに 1 秒あたり最大 50 回呼び出すことができます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、Alibaba Cloud アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	ImportDevice	実行する操作。値を ImportDevice に設定します。
ProductKey	String	はい	a1BwAGV****	デバイスが属するプロダクトの ProductKey。
DeviceName	String	はい	light	デバイスの DeviceName。 DeviceName は 4 ～ 32 文字で、文字、数字、ハイフン（-）、アンダースコア（_）、アットマーク（@）、ピリオド（.）、コロン（:）を含めることができます。 DeviceName はプロダクト内で一意である必要があります。
DeviceSecret	String	はい	b4d43f7******10ba5e5	デバイスの DeviceSecret。 DeviceSecret は 1 ～ 32 文字で、文字、数字、ハイフン（-）、アンダースコア（_）、アットマーク（@）、ピリオド（.）、コロン（:）を含めることができます。
Nickname	String	いいえ	Campus light	デバイスのエイリアス。エイリアスは 1 ～ 64 文字で、文字、数字、アンダースコア（_）を含めることができます。説明このパラメーターを設定しない場合、IoT Platform はデバイスのエイリアスを生成しません。
Sn	String	いいえ	QC4******001	デバイスのシリアル番号（SN）。 SN は 1 ～ 64 文字で、文字、数字、アンダースコア（_）を含めることができます。説明このパラメーターを設定しない場合、IoT Platform はデバイスの SN を生成しません。
IotInstanceId	String	いいえ	iot-1n8t****	インスタンスの ID。インスタンスの ID は、IoT Platform コンソールの概要ページで取得できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しない場合、呼び出しは失敗します。インスタンスに概要ページまたは ID が生成されていない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出す際には、共通のリクエストパラメーターを設定する必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるデバイス情報。
DeviceName	String	light	デバイスの DeviceName。重要情報を機密にしてください。
DeviceSecret	String	b4d43f7******10ba5e5	デバイスの DeviceSecret。重要情報を機密にしてください。
IotId	String	1O4YPNtRqB2anumz2Canp4GB7*****	デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。重要情報を機密にしてください。
Nickname	String	Campus light	デバイスのエイリアス。説明デバイスのエイリアスを指定しない場合、このパラメーターは空になります。
ProductKey	String	a1BwAGV****	デバイスが属するプロダクトの ProductKey。
Sn	String	QC4******001	デバイスの SN。説明デバイスの SN を指定しない場合、このパラメーターは空になります。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ImportDevice
&DeviceName=device1
&DeviceSecret=b4d43f7******10ba5e5
&ProductKey=a1BwAGV****
&IotInstanceId=iot-1n8t****
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<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 形式

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

エラーコード

HttpCode	エラーコード	エラーメッセージ	説明
200	iot.device.CreateDeviceFailed	デバイスの作成中にエラーが発生しました。	システムがデバイスの作成に失敗したために返されるエラーメッセージ。
200	iot.device.AlreadyExistedDeviceName	DeviceName は既に存在します。	DeviceName が既に存在するために返されるエラーメッセージ。

エラーコードの一覧については、「サービスエラーコード」をご参照ください。