すべてのプロダクト
Search
ドキュメントセンター

IoT Platform:BatchImportVehicleDevice

最終更新日:Apr 17, 2025

複数のデバイスをクラウドゲートウェイ製品に一度に追加します。

使用方法

BatchImportVehicleDevice 操作は、複数のデバイスを JT/T 808 または GB/T 32960 クラウドゲートウェイ製品に一度に追加する場合に適しています。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター

タイプ

必須

説明

Action String Yes BatchImportVehicleDevice

実行する操作。値を BatchImportVehicleDevice に設定します。

IotInstanceId String Yes iot-1n8t****

インスタンスの ID。インスタンスの ID は、IoT Platform コンソールの [概要] タブで確認できます。

詳細については、「概要」をご参照ください。

ProductKey String Yes a1Bw****

デバイスが属する製品の ProductKey

DeviceList.N.Manufacturer String No mf0001

デバイスの製造元 ID。JT/T 808 クラウドゲートウェイデバイスを追加する場合、このパラメーターは必須です。

製造元 ID は 4 ~ 11 文字で、文字、数字、およびハイフン (-) を含めることができます。

説明 1 回の呼び出しで最大 10,000 個のデバイス製造元 ID を指定できます。デバイス製造元 ID の数が制限を超えると、超過したデバイス製造元 ID は破棄されます。
DeviceList.N.DeviceModel String No dm0001

デバイスのデバイスモデル。JT/T 808 クラウドゲートウェイデバイスを追加する場合、このパラメーターは必須です。

デバイスモデルは 4 ~ 30 文字で、文字、数字、およびハイフン (-) を含めることができます。

説明 1 回の呼び出しで最大 10,000 個のデバイスモデルを指定できます。デバイスモデルの数が制限を超えると、超過したデバイスモデルは破棄されます。
DeviceList.N.DeviceId String No di0001

デバイスの ID。JT/T 808 クラウドゲートウェイデバイスを追加する場合、このパラメーターは必須です。

ID は 4 ~ 30 文字で、文字、数字、およびハイフン (-) を含めることができます。

説明 1 回の呼び出しで最大 10,000 個のデバイス ID を指定できます。デバイス ID の数が制限を超えると、超過したデバイス ID は破棄されます。
DeviceList.N.DeviceName String No vin0001

デバイスの DeviceName。JT/T 808 クラウドゲートウェイデバイスを追加する場合は、このパラメーターの値としてデバイスの車両識別番号 (VIN) を指定する必要があります。

DeviceName は 4 ~ 17 文字で、文字と数字を含めることができます。

説明 1 回の呼び出しで最大 10,000 個の DeviceName を指定できます。DeviceName の数が制限を超えると、超過した DeviceName は破棄されます。

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

レスポンスパラメーター

パラメーター

タイプ

説明

Code String iot.system.SystemException

呼び出しが失敗した場合に返されるエラーコード。詳細については、このトピックの「エラーコード」セクションをご参照ください。

Data Struct

呼び出しが成功した場合に返されるデータ。

ApplyId Long 1295006

呼び出しが成功した場合にリクエストに対して返されるアプリケーション ID (ApplyId)。

InvalidDetailList Array of InvalidDetailList

呼び出しが失敗した場合に返される無効なデバイスの詳細。

InvalidDetailList
DeviceId String di_*0001

JT/T 808 クラウドゲートウェイデバイスの ID。

DeviceModel String dm_*0001

JT/T 808 クラウドゲートウェイデバイスのデバイスモデル。

DeviceName String device_*0001

GB/T 32960 クラウドゲートウェイデバイスの DeviceName。

ErrorMsg String The device name is illegal.

呼び出しが失敗した場合に返されるエラーメッセージ。

Manufacturer String mf_*0001

JT/T 808 クラウドゲートウェイデバイスの製造元 ID。

InvalidDeviceIdList List { "InvalidDeviceIdList": [ "di&^", "&*G%" ] }

JT/T 808 クラウドゲートウェイデバイスの追加に失敗した場合に返される無効なデバイス ID。

InvalidDeviceModelList List { "InvalidDeviceModelList": [ "dm$", "dm_uh" ] }

JT/T 808 クラウドゲートウェイデバイスの追加に失敗した場合に返される無効なデバイスモデル。

InvalidDeviceNameList List { "InvalidDeviceNameList": [ "APT$", "aw" ] }

GB/T 32960 クラウドゲートウェイデバイスの追加に失敗した場合に返される無効な DeviceName。

InvalidManufacturerList List { "InvalidManufacturerList": [ "bm*$", "#$F" ] }

JT/T 808 クラウドゲートウェイデバイスの追加に失敗した場合に返される無効なデバイス製造元 ID。

RepeatedDeviceIdList List { "RepeatedDeviceIdList": [ "^67$", "1" ] }

JT/T 808 クラウドゲートウェイデバイスの追加に失敗した場合に返される重複したデバイス ID。

RepeatedDeviceNameList List { "RepeatedDeviceNameList": [ "abcd", "asdf" ] }

GB/T 32960 クラウドゲートウェイデバイスの追加に失敗した場合に返される重複した DeviceName。

ErrorMessage String A system exception occurred.

呼び出しが失敗した場合に返されるエラーメッセージ。

RequestId String E4C0FF92-2A86-41DB-92D3-73B60310D25E

リクエストの ID。

Success Boolean true

呼び出しが成功したかどうかを示します。有効な値:

  • true: 呼び出しは成功しました。
  • false: 呼び出しは失敗しました。

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchImportVehicleDevice
&DeviceList.1.DeviceModel=dm0001
&DeviceList.1.Manufacturer=mf0001
&DeviceList.1.DeviceId=di0001
&ProductKey=a1Bw****
&IotInstanceId=iot-cv3********
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<BatchImportVehicleDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <ApplyId>1295006</ApplyId>
  </Data>
  <Code></Code>
  <Success>true</Success>
</BatchImportVehicleDeviceResponse>

JSON 形式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "ApplyId": 1295006
    },
    "Code": "",
    "Success": true
}

エラーコード

HttpCode

エラーコード

エラーメッセージ

説明

400 iot.device.TooManyDeviceNamesPerRequest The devices you query exceed the maximum number. リクエストで指定した DeviceName の数が制限を超えています。
400 iot.device.ApplyManyDevicesFailed An error occurred while creating multiple devices. 一度に複数のデバイスを作成するリクエストが失敗しました。
400 iot.common.InvalidTenant the device tenantId is invalid. デバイスのテナント情報が無効です。
400 iot.device.InvalidFormattedDeviceNameInNameArray The DeviceName list contains an invalid DeviceName. DeviceName リストに無効な DeviceName が存在します。
400 iot.prod.InvalidProductAuthType The product authentication type is invalid. 製品の認証タイプが無効です。
400 iot.prod.InvalidFormattedProductkey The ProductKey format is invalid. ProductKey パラメーターの値の形式が無効です。

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