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

プロダクトを作成します。

使用方法

プロダクトの作成に Thing Specification Language（TSL）モデルが必要な場合は、AliyunCommodityCode パラメータを iothub_senior に設定し、DataFormat パラメータを指定する必要があります。詳細については、このトピックの リクエストパラメータ セクションをご参照ください。

QPS 制限

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

説明

Alibaba Cloud アカウントの Resource Access Management（RAM）ユーザーは、アカウントのクォータを共有します。

デバッグ

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

リクエストパラメータ

パラメータ	タイプ	必須	例	説明
Action	String	はい	CreateProduct	実行する操作。値を CreateProduct に設定します。
NodeType	Integer	はい	0	プロダクトのノードタイプ。有効な値： 0：デバイス。サブデバイスをデバイスに接続することはできません。デバイスは IoT Platform に直接接続することも、ゲートウェイのサブデバイスとして IoT Platform に接続することもできます。デバイスをゲートウェイのサブデバイスとして使用する場合は、ProtocolType を指定する必要があります。 1：ゲートウェイ。サブデバイスをゲートウェイに接続できます。ゲートウェイは、サブデバイスを管理し、サブデバイスとのトポロジ関係を維持し、トポロジ関係を IoT Platform と同期できます。
ProductName	String	はい	Light	プロダクトの名前。名前は 4 ～ 30 文字で、英字、数字、アンダースコア（_）を含めることができます。各中国語の文字は 2 文字としてカウントされます。重要各プロダクト名は、現在のインスタンス内で一意である必要があります。
IotInstanceId	String	いいえ	iot-*-v64*	インスタンスの ID。インスタンスの ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメータを指定する必要があります。指定しない場合、リクエストは失敗します。 IoT Platform コンソールに概要ページまたはインスタンス ID が表示されない場合は、このパラメータを指定する必要はありません。詳細については、「概要」をご参照ください。
DataFormat	Integer	いいえ	1	データ形式。有効な値： 0：カスタムデータ形式。 1：Alink JSON 形式。
Description	String	いいえ	Product test	プロダクトの説明。説明は最大 100 文字まで入力できます。
AliyunCommodityCode	String	いいえ	iothub_senior	プロダクトのエディション。デフォルトでは、このパラメータを指定しない場合、Basic Edition のプロダクトが自動的に作成されます。 TSL モデルを使用してプロダクトを定義することはできません。このパラメータを指定する場合は、値を iothub_senior に設定します。この場合、TSL モデルをサポートするプロダクトが作成されます。 DataFormat パラメータも指定する必要があります。重要 Basic Edition のプロダクトの場合、IoT Platform コンソールでオンラインデバッグ機能を使用することはできません。
Id2	Boolean	いいえ	false	このパラメータを指定する必要はありません。
ProtocolType	String	いいえ	modbus	プロダクトのデバイスがゲートウェイに接続するために使用するプロトコル。 AliyunCommodityCode が iothub_senior に設定されていて、ゲートウェイがプロダクトのデバイスを IoT Platform に接続する必要がある場合は、このパラメータを指定する必要があります。有効な値： modbus：Modbus。 opc-ua：OPC UA（Open Platform Communication Unified Architecture）。 customize：カスタムプロトコル。 ble：BLE（Bluetooth Low Energy）。 zigbee：ZigBee。
NetType	String	いいえ	WIFI	ネットワーク接続方法。このパラメータは、プロダクトのデバイスがゲートウェイまたは直接接続デバイスである場合に必須です。有効な値： WIFI CELLULAR ETHERNET OTHER デフォルト値：WIFI。
JoinPermissionId	String	いいえ	8***	このパラメータを指定する必要はありません。
ResourceGroupId	String	いいえ	rg-acfmxazb4ph***	リソースグループの ID。重要 IoT Platform では、リソースグループ別にインスタンスリソースのみを管理できます。このリクエストでは、ResourceGroupId は有効になりません。このパラメータを指定する必要はありません。この API 操作を使用して過去の要求で構成したリソースグループは引き続き有効です。
AuthType	String	いいえ	secret	プロダクトのデバイスを IoT Platform に接続するために使用される認証方式。このパラメータを指定する必要はありません。デフォルト値 secret が自動的に使用されます。詳細については、「TCP 経由で MQTT 接続を確立する」をご参照ください。
CategoryKey	String	いいえ	Lighting	プロダクトカテゴリの識別子。このパラメータを指定すると、プロダクトカテゴリの TSL モデルが使用されます。指定しない場合、TSL モデルは使用されません。 ListThingTemplates 操作を呼び出して、IoT Platform によって事前定義されているプロダクトカテゴリの詳細をクエリし、カテゴリキーを取得できます。
PublishAuto	Boolean	いいえ	false	プロダクトの作成後に TSL モデルを公開するかどうかを指定します。有効な値： true false デフォルト値：true。
ValidateType	Integer	いいえ	1	データ検証のレベル。デフォルトでは、このパラメータを指定しない場合、弱い検証が実行されます。有効な値： 1：弱い検証。 IoT Platform は、データの identifier フィールドと dataType フィールドのみを検証します。すべてのデータが転送されます。 IoT Platform コンソールでは、データはデバイスの詳細ページの TSL データタブに表示されます。検証に失敗したデータは表示されません。転送されたデータの checkFailedData パラメータで、検証に失敗したデータを確認できます。詳細については、「データ形式」をご参照ください。 2：検証なし。 IoT Platform はデータを検証しません。すべてのデータが転送されます。 IoT Platform コンソールでは、データはデバイスの詳細ページの TSL データタブに表示されません。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	200	リクエストが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		リクエストが成功した場合に返されるプロダクト情報。
AliyunCommodityCode	String	iothub_senior	プロダクトで TSL モデルが使用されているかどうかを示します。有効な値： iothub_senior: TSL モデルが使用されます。 iothub: TSL モデルは使用されません。
AuthType	String	secret	プロダクトのデバイスを IoT Platform に接続するために使用される認証方式。
DataFormat	Integer	1	データ形式。有効な値： 0: カスタムデータ形式。 1: Alink JSON 形式。説明このパラメーターは、AliyunCommodityCode が iothub_senior に設定されている場合にのみ返されます。
Description	String	Product test	プロダクトの説明。
Id2	Boolean	false	ID² ベース認証が有効になっているかどうかを示します。有効な値： true false
NodeType	Integer	0	プロダクトのノードタイプ。有効な値： 0: デバイス。サブデバイスをデバイスにアタッチすることはできません。デバイスは IoT Platform に直接接続することも、ゲートウェイのサブデバイスとして IoT Platform に接続することもできます。 1: ゲートウェイ。サブデバイスをゲートウェイにアタッチできます。ゲートウェイは、サブデバイスを管理し、サブデバイスとのトポロジ関係を維持し、トポロジ関係を IoT Platform に同期できます。説明このパラメーターは、AliyunCommodityCode が iothub_senior に設定されている場合にのみ返されます。
ProductKey	String	a1FlqIQ****	プロダクトの ProductKey。ProductKey は、IoT Platform がプロダクトに発行する GUID です。説明 ProductKey は機密にしてください。特定の操作を実行するときに ProductKey が必要になります。
ProductName	String	Test	プロダクトの名前。
ProductSecret	String	U5tW7i44uilc****	プロダクトの ProductSecret。
ProtocolType	String	modbus	プロダクトのデバイスがゲートウェイに接続するために使用するプロトコル。説明このパラメーターは、AliyunCommodityCode が iothub_senior に設定されている場合にのみ返されます。
ErrorMessage	String	システム例外が発生しました。	リクエストが失敗した場合に返されるエラーメッセージ。
ProductKey	String	a1FlqIQ****	プロダクトの ProductKey。ProductKey は、IoT Platform がプロダクトに発行する GUID です。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	リクエストが成功したかどうかを示します。有効な値： true false

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProduct
&AliyunCommodityCode=iothub_senior
&AuthType=secret
&DataFormat=1
&Description=Product test
&NodeType=0
&ResourceGroupId=rg-acfmxazb4ph****
&ProductName=Test
&ProtocolType=modbus
&CategoryKey=Lighting
&PublishAuto=false
&<Common request parameters>

正常なレスポンスの例

XML フォーマット

<CreateProductResponse>
      <Data>
            <Description>Product test</Description>
            <DataFormat>1</DataFormat>
            <ProtocolType>modbus</ProtocolType>
            <ProductKey>a1FlqIQ****</ProductKey>
            <ProductSecret>U5tW7i44uilc****</ProductSecret>
            <NodeType>0</NodeType>
            <ProductName>Test</ProductName>
            <AliyunCommodityCode>iothub_senior</AliyunCommodityCode>
            <AuthType>secret</AuthType>
            <ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
      </Data>
      <ProductKey>a1FlqIQ****</ProductKey>
      <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
      <Success>true</Success>
</CreateProductResponse>

JSON フォーマット

{
  "Data": {
    "Description": "Product test",
    "DataFormat": 1,
    "ProtocolType": "modbus",
    "ProductKey": "a1FlqIQ****",
    "ProductSecret": "U5tW7i44uilc****",
    "NodeType": 0,
    "ProductName": "Test",
    "AliyunCommodityCode": "iothub_senior",
    "AuthType": "secret",
    "ResourceGroupId": "rg-acfmxazb4ph****"
  },
  "ProductKey": "a1FlqIQ****",
  "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
  "Success": true
}

レスポンスパラメータ

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