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

プロダクトにデバイスを登録します。

使用方法

この操作を呼び出してプロダクトにデバイスを登録すると、デバイスは IoT Platform コンソール内のプロダクトに追加されます。デバイスが登録されると、IoT Platform はデバイスに IotId パラメーターを発行します。このパラメーターは、デバイスのグローバル一意識別子（GUID）です。デバイスに対して操作を実行するには、IotId パラメーターを使用してデバイスを識別する必要があります。

ProductKey パラメーターと DeviceName パラメーターの組み合わせを使用してデバイスを識別することもできます。ProductKey は、プロダクトの作成時に IoT Platform によってプロダクトに発行されます。DeviceName は、デバイスの作成時に指定またはランダムに生成されます。IotId パラメーターは、ProductKey パラメーターと DeviceName パラメーターの組み合わせよりも優先順位が高くなります。

複数のデバイスを同時にプロダクトに登録する方法については、「BatchRegisterDeviceWithApplyId」をご参照ください。

制限

各 Alibaba Cloud アカウントは、最大 30 クエリ/秒（QPS）を実行できます。

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

デバッグ

Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	RegisterDevice	実行する操作。値を RegisterDevice に設定します。
ProductKey	String	はい	a1BwAGV****	デバイスが属するプロダクトの ProductKey。ProductKey は、IoT Platform によってプロダクトに発行される GUID です。 IoT Platform コンソールを使用するか、QueryProductList 操作を呼び出して、現在のアカウント内のすべてのプロダクトに関する情報を表示できます。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
DeviceName	String	いいえ	light	デバイスの DeviceName。名前は 4 ～ 32 文字で、文字、数字、ハイフン（-）、アンダースコア（_）、アットマーク（@）、ピリオド（.）、コロン（:）を含めることができます。 DeviceName パラメーターと ProductKey パラメーターの組み合わせを使用してデバイスを識別できます。説明このパラメーターを指定しないと、IoT Platform は DeviceName をランダムに生成します。
DevEui	String	いいえ	e8SDdgeIlk3nED****	LoRaWAN デバイスの DevEUI。 LoRaWAN デバイスを作成する場合、このパラメーターは必須です。
Nickname	String	いいえ	Campus light	デバイスのエイリアス。エイリアスは 4 ～ 64 文字で、文字、数字、アンダースコア（_）を含めることができます。説明このパラメーターを指定しないと、IoT Platform はデバイスのエイリアスを生成しません。
PinCode	String	いいえ	DIe80dfeg*****	LoRaWAN デバイスの PIN コード。このパラメーターは、DevEUI を検証するために使用されます。 LoRaWAN デバイスを作成する場合は、LoraNodeType を ALIYUNDEFINED に設定します。このパラメーターは必須です。
JoinEui	String	いいえ	Ede4tde8erth****	LoRaWAN デバイスの JoinEUI。 LoRaWAN デバイスを作成する場合は、LoraNodeType を USERDEFINED に設定します。このパラメーターは必須です。
AppKey	String	いいえ	674f***	LoRaWAN デバイスの AppKey。 LoRaWAN デバイスを作成する場合は、LoraNodeType を USERDEFINED に設定します。このパラメーターは必須です。
LoraNodeType	String	いいえ	ALIYUNDEFINED	LoRaWAN デバイスのタイプ。有効な値： ALIYUNDEFINED: デバイスは Alibaba Cloud によって発行されます。DevEui と PinCode を指定する必要があります。 USERDEFINED: デバイスはユーザー定義です。DevEui、JoinEui、および AppKey を指定する必要があります。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるデバイス情報。
DevEui	String	e8SDdgeIlk3nED****	LoRaWAN デバイスの DevEUI。このパラメーターは、LoRaWAN デバイスを作成する場合にのみ返されます。
DeviceName	String	light	デバイスの DeviceName。重要情報を機密にしてください。
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	デバイスの DeviceSecret。重要情報を機密にしてください。
IotId	String	1O4YPNtRqB2anumz2Canp4GB7q****	デバイスの ID。ID は、IoT Platform によってデバイスに発行される一意の識別子です。重要情報を機密にしてください。
JoinEui	String	Ede4tde8erth****	LoRaWAN デバイスの JoinEUI。このパラメーターは、LoRaWAN デバイスを作成する場合にのみ返されます。
Nickname	String	Campus light	デバイスのエイリアス。デバイスのエイリアスを指定しないと、このパラメーターは空になります。
ProductKey	String	a1BwAGV****	デバイスが属するプロダクトの ProductKey。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=RegisterDevice
&ProductKey=a1rYuVF****
&DeviceName=device1
&Nickname=detectors_in_beijing
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<RegisterDeviceResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
  <Data>
        <DeviceName>device1</DeviceName>
        <ProductKey>a1rYuVF****</ProductKey>
        <DeviceSecret>tXHf4ezGEHcwdyMwoCDHGBmk9avi****</DeviceSecret>
        <IotId>CqXL5h5ysRTA4NxjABjj0010fa****</IotId>
        <Nickname>detectors_in_beijing</Nickname>
  </Data>
</RegisterDeviceResponse>

JSON 形式

{
    "RequestId": "57b144cf-09fc-4916-a272-a62902d5b207", 
    "Success": true, 
    "Data": {
        "DeviceName": "device1", 
        "ProductKey": "a1rYuVF****", 
        "DeviceSecret": "tXHf4ezGEHcwdyMwoCDHGBmk9avi****", 
        "IotId": "CqXL5h5ysRTA4NxjABjj0010fa****", 
        "Nickname": "detectors_in_beijing"
    }
}

エラーコード

エラーコードの一覧については、API エラーセンターをご覧ください。